PSModule · MariusStorhaug · Apr 17, 2025 · Mar 5, 2025 · Mar 5, 2025 · Mar 5, 2025
diff --git a/.github/linters/.jscpd.json b/.github/linters/.jscpd.json
@@ -4,7 +4,8 @@
         "consoleFull"
     ],
     "ignore": [
-        "**/tests/**"
+        "**/tests/**",
+        "**/linters/**"
     ],
     "absolute": true
 }
diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml
@@ -27,6 +27,12 @@ jobs:
 
       - name: Action-Test
         uses: ./
-        with:
-          working-directory: ./tests
-          subject: PSModule
+
+      - name: Verify Helpers Module Installation
+        shell: pwsh
+        run: |
+          if (Get-Module -Name Helpers -ListAvailable) {
+            Write-Host "Helpers module successfully installed."
+          } else {
+            throw "Helpers module not found!"
+          }
diff --git a/README.md b/README.md
@@ -1,17 +1,63 @@
-# Template-Action
+# Install-PSModuleHelpers
 
-A template repository for GitHub Actions
+A GitHub Action to install and configure the PSModule helper modules for use in continuous integration and delivery (CI/CD) workflows. This action is
+a critical component for setting up a standardized PowerShell environment across repositories using the PSModule framework.
+
+This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). It is recommended to use the
+[Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module.
+
+## What this action does
+
+- Removes any existing instances of the `Helpers` module from the PowerShell session.
+- Copies the latest version of the `Helpers` module into the PowerShell module directory.
+- Imports the `Helpers` module, ensuring it is available for subsequent steps.
+
+This action helps maintain consistency and reliability across workflows that depend on the PSModule framework.
 
 ## Usage
 
-### Inputs
+```yaml
+- name: Install PSModule Helpers
+  uses: PSModule/Install-PSModuleHelpers@v1
+```
+
+## Inputs
+
+_No inputs required._
 
-### Secrets
+## Secrets
 
-### Outputs
+_No secrets required._
 
-### Example
+## Outputs
+
+This action does not provide any outputs.
+
+## Example
+
+Here's a complete workflow example demonstrating how to use the Install-PSModuleHelpers action:
 
 ```yaml
-Example here
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install PSModule Helpers
+        uses: PSModule/Install-PSModuleHelpers@v1
+
+      - name: Run additional steps
+        shell: pwsh
+        run: |
+          # Example usage of imported Helpers module
+          Get-Command -Module Helpers
 ```
diff --git a/action.yml b/action.yml
@@ -1,48 +1,15 @@
-name: {{ NAME }}
-description: {{ DESCRIPTION }}
+name: Install-PSModuleHelpers
+description: Installs the PSModule helpers.
 author: PSModule
 branding:
   icon: upload-cloud
   color: white
 
-inputs:
-  subject:
-    description: The subject to greet
-    required: false
-    default: World
-  Debug:
-    description: Enable debug output.
-    required: false
-    default: 'false'
-  Verbose:
-    description: Enable verbose output.
-    required: false
-    default: 'false'
-  Version:
-    description: Specifies the version of the GitHub module to be installed. The value must be an exact version.
-    required: false
-  Prerelease:
-    description: Allow prerelease versions if available.
-    required: false
-    default: 'false'
-  WorkingDirectory:
-    description: The working directory where the script will run from.
-    required: false
-    default: ${{ github.workspace }}
-
 runs:
   using: composite
   steps:
-    - name: {{ NAME }}
-      uses: PSModule/GitHub-Script@v1
-      env:
-        {{ ORG }}_{{ NAME }}_INPUT_subject: ${{ inputs.subject }}
-      with:
-        Debug: ${{ inputs.Debug }}
-        Prerelease: ${{ inputs.Prerelease }}
-        Verbose: ${{ inputs.Verbose }}
-        Version: ${{ inputs.Version }}
-        WorkingDirectory: ${{ inputs.WorkingDirectory }}
-        Script: |
-          # {{ NAME }}
-          ${{ github.action_path }}/scripts/main.ps1
+    - name: Install-PSModuleHelpers
+      shell: pwsh
+      run: |
+        # Install-PSModuleHelpers
+        ${{ github.action_path }}/scripts/main.ps1
diff --git a/scripts/Helpers/Helpers.psd1 b/scripts/Helpers/Helpers.psd1
@@ -0,0 +1,4 @@
+@{
+    RootModule    = 'Helpers.psm1'
+    ModuleVersion = '999.0.0'
+}