Refactor GitHub Actions: Consolidate Install-PSModuleHelpers into Install-PSModule

MariusStorhaug · MariusStorhaug · commit 90aec5ecf1d2 · 2026-07-17T23:22:09.000+02:00
- Added PSScriptAnalyzer configuration file for code analysis rules.
- Created main script for Install-PSModule action to manage module installation.
- Removed Install-PSModuleHelpers action and associated files.
- Updated workflows to replace Install-PSModuleHelpers with Install-PSModule.
diff --git a/.github/actions/Build-PSModule/action.yml b/.github/actions/Build-PSModule/action.yml
@@ -28,8 +28,8 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Install-PSModuleHelpers
-      uses: ./_wf/.github/actions/Install-PSModuleHelpers
+    - name: Install-PSModule
+      uses: ./_wf/.github/actions/Install-PSModule
 
     - name: Run Build-PSModule
       shell: pwsh
diff --git a/.github/actions/Document-PSModule/action.yml b/.github/actions/Document-PSModule/action.yml
@@ -18,8 +18,8 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Install-PSModuleHelpers
-      uses: ./_wf/.github/actions/Install-PSModuleHelpers
+    - name: Install-PSModule
+      uses: ./_wf/.github/actions/Install-PSModule
 
     - name: Document-PSModule
       shell: pwsh
diff --git a/.github/actions/Initialize-PSModule/README.md b/.github/actions/Initialize-PSModule/README.md
diff --git a/.github/actions/Initialize-PSModule/action.yml b/.github/actions/Initialize-PSModule/action.yml
diff --git a/.github/actions/Initialize-PSModule/src/main.ps1 b/.github/actions/Initialize-PSModule/src/main.ps1
diff --git a/.github/actions/Install-PSModule/README.md b/.github/actions/Install-PSModule/README.md
@@ -1,4 +1,4 @@
-# Install-PSModuleHelpers
+# Install-PSModule
 
 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.
@@ -18,7 +18,7 @@ This action helps maintain consistency and reliability across workflows that dep
 
 ```yaml
 - name: Install PSModule Helpers
-  uses: PSModule/Install-PSModuleHelpers@v1
+  uses: PSModule/Install-PSModule@v1
 ```
 
 ## Inputs
@@ -35,7 +35,7 @@ This action does not provide any outputs.
 
 ## Example
 
-Here's a complete workflow example demonstrating how to use the Install-PSModuleHelpers action:
+Here's a complete workflow example demonstrating how to use the Install-PSModule action:
 
 ```yaml
 name: CI
@@ -53,7 +53,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Install PSModule Helpers
-        uses: PSModule/Install-PSModuleHelpers@v1
+        uses: PSModule/Install-PSModule@v1
 
       - name: Run additional steps
         shell: pwsh
diff --git a/.github/actions/Install-PSModule/action.yml b/.github/actions/Install-PSModule/action.yml
@@ -0,0 +1,11 @@
+name: Install-PSModule
+description: Installs PSModule.
+
+runs:
+  using: composite
+  steps:
+    - name: Install-PSModule
+      shell: pwsh
+      run: |
+        # Install-PSModule
+        ${{ github.action_path }}/src/main.ps1
diff --git a/.github/actions/Install-PSModule/src/PSModule/PSModule.psd1 b/.github/actions/Install-PSModule/src/PSModule/PSModule.psd1
@@ -0,0 +1,4 @@
+@{
+    RootModule    = 'PSModule.psm1'
+    ModuleVersion = '999.0.0'
+}
diff --git a/.github/actions/Install-PSModule/src/PSModule/PSModule.psm1 b/.github/actions/Install-PSModule/src/PSModule/PSModule.psm1
@@ -1348,4 +1348,3 @@ function Import-TestData {
     Add-EnvFromMap -Map $data.secrets -Name 'secrets' -Mask
     Add-EnvFromMap -Map $data.variables -Name 'variables'
 }
-
diff --git a/.github/actions/Install-PSModule/src/PSModule/PSScriptAnalyzer.Tests.psd1 b/.github/actions/Install-PSModule/src/PSModule/PSScriptAnalyzer.Tests.psd1
diff --git a/.github/actions/Install-PSModule/src/main.ps1 b/.github/actions/Install-PSModule/src/main.ps1
@@ -0,0 +1,17 @@
+﻿[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSAvoidUsingWriteHost', '',
+    Justification = 'Wriite to the GitHub Actions log, not the pipeline.'
+)]
+[CmdletBinding()]
+param()
+
+$moduleName = 'PSModule'
+$PSModulePath = $env:PSModulePath -split [System.IO.Path]::PathSeparator | Select-Object -First 1
+Remove-Module -Name $moduleName -Force -ErrorAction SilentlyContinue
+Get-Command -Module $moduleName | ForEach-Object { Remove-Item -Path function:$_ -Force }
+Get-Item -Path "$PSModulePath/$moduleName/999.0.0" -ErrorAction SilentlyContinue | Remove-Item -Recurse -Force
+$modulePath = New-Item -Path "$PSModulePath/$moduleName/999.0.0" -ItemType Directory -Force | Select-Object -ExpandProperty FullName
+Copy-Item -Path "$PSScriptRoot/$moduleName/*" -Destination $modulePath -Recurse -Force
+Write-Host ":::group::Importing $moduleName"
+Import-Module -Name $moduleName -Verbose
+Write-Host '::endgroup::'
diff --git a/.github/actions/Install-PSModuleHelpers/action.yml b/.github/actions/Install-PSModuleHelpers/action.yml
diff --git a/.github/actions/Install-PSModuleHelpers/src/Helpers/Helpers.psd1 b/.github/actions/Install-PSModuleHelpers/src/Helpers/Helpers.psd1
diff --git a/.github/actions/Install-PSModuleHelpers/src/main.ps1 b/.github/actions/Install-PSModuleHelpers/src/main.ps1
diff --git a/.github/actions/Publish-PSModule/action.yml b/.github/actions/Publish-PSModule/action.yml
@@ -45,8 +45,8 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Install-PSModuleHelpers
-      uses: ./_wf/.github/actions/Install-PSModuleHelpers
+    - name: Install-PSModule
+      uses: ./_wf/.github/actions/Install-PSModule
 
     - name: Update Microsoft.PowerShell.PSResourceGet
       shell: pwsh
diff --git a/.github/actions/Resolve-PSModuleVersion/action.yml b/.github/actions/Resolve-PSModuleVersion/action.yml
@@ -53,8 +53,8 @@ outputs:
 runs:
   using: composite
   steps:
-    - name: Install-PSModuleHelpers
-      uses: ./_wf/.github/actions/Install-PSModuleHelpers
+    - name: Install-PSModule
+      uses: ./_wf/.github/actions/Install-PSModule
 
     - name: Install PSSemVer
       shell: pwsh
diff --git a/.github/actions/Test-PSModule/action.yml b/.github/actions/Test-PSModule/action.yml
@@ -266,8 +266,8 @@ outputs:
 runs:
   using: composite
   steps:
-    - name: Install-PSModuleHelpers
-      uses: ./_wf/.github/actions/Install-PSModuleHelpers
+    - name: Install-PSModule
+      uses: ./_wf/.github/actions/Install-PSModule
 
     - name: Get test paths
       shell: pwsh
diff --git a/.github/workflows/AfterAll-ModuleLocal.yml b/.github/workflows/AfterAll-ModuleLocal.yml
@@ -39,8 +39,8 @@ jobs:
           path: _wf
           persist-credentials: false
 
-      - name: Install-PSModuleHelpers
-        uses: ./_wf/.github/actions/Install-PSModuleHelpers
+      - name: Install-PSModule
+        uses: ./_wf/.github/actions/Install-PSModule
 
       - name: Expose caller-provided test data
         uses: ./_wf/.github/actions/Expose-TestData
diff --git a/.github/workflows/BeforeAll-ModuleLocal.yml b/.github/workflows/BeforeAll-ModuleLocal.yml
@@ -39,8 +39,8 @@ jobs:
           path: _wf
           persist-credentials: false
 
-      - name: Install-PSModuleHelpers
-        uses: ./_wf/.github/actions/Install-PSModuleHelpers
+      - name: Install-PSModule
+        uses: ./_wf/.github/actions/Install-PSModule
 
       - name: Expose caller-provided test data
         uses: ./_wf/.github/actions/Expose-TestData
diff --git a/.github/workflows/Build-Site.yml b/.github/workflows/Build-Site.yml
@@ -30,8 +30,8 @@ jobs:
           path: _wf
           persist-credentials: false
 
-      - name: Install-PSModuleHelpers
-        uses: ./_wf/.github/actions/Install-PSModuleHelpers
+      - name: Install-PSModule
+        uses: ./_wf/.github/actions/Install-PSModule
 
       - name: Download docs artifact
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
diff --git a/.github/workflows/Test-ModuleLocal.yml b/.github/workflows/Test-ModuleLocal.yml
@@ -50,8 +50,8 @@ jobs:
           name: module
           path: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/module
 
-      - name: Install-PSModuleHelpers
-        uses: ./_wf/.github/actions/Install-PSModuleHelpers
+      - name: Install-PSModule
+        uses: ./_wf/.github/actions/Install-PSModule
 
       - name: Expose caller-provided test data
         uses: ./_wf/.github/actions/Expose-TestData

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +@{
 +    RootModule    = 'PSModule.psm1'
 +    ModuleVersion = '999.0.0'
 +}
Original file line number	Diff line number	Diff line change
`@@ -1348,4 +1348,3 @@ function Import-TestData {`
`1348`	`1348`	`Add-EnvFromMap -Map $data.secrets -Name 'secrets' -Mask`
`1349`	`1349`	`Add-EnvFromMap -Map $data.variables -Name 'variables'`
`1350`	`1350`	`}`
`1351`		`-`