ci: Update deployments to only create one module artifact

Author: deadlydog

.github/workflows/build-and-test-powershell-module.yml

@@ -20,12 +20,18 @@ on:
       powerShellModuleName:
         description: 'The name of the PowerShell module being built.'
         value: ${{ jobs.build-and-test.outputs.powerShellModuleName }}
-      prereleaseModuleArtifactName:
-        description: 'The name of the prerelease module artifact created by the build.'
-        value: ${{ jobs.build-and-test.outputs.prereleaseModuleArtifactName }}
-      stableModuleArtifactName:
-        description: 'The name of the stable module artifact created by the build.'
-        value: ${{ jobs.build-and-test.outputs.stableModuleArtifactName }}
+      stableVersionNumber:
+        description: 'The stable version number of the PowerShell module created by the build.'
+        value: ${{ jobs.build-and-test.outputs.stableVersionNumber }}
+      prereleaseVersionNumber:
+        description: 'The full prerelease version number of the PowerShell module created by the build.'
+        value: ${{ jobs.build-and-test.outputs.prereleaseVersionNumber }}
+      prereleaseVersionLabel:
+        description: 'The prerelease label of the PowerShell module created by the build.'
+        value: ${{ jobs.build-and-test.outputs.prereleaseVersionLabel }}
+      moduleArtifactName:
+        description: 'The name of the module artifact created by the build.'
+        value: ${{ jobs.build-and-test.outputs.moduleArtifactName }}
       deployFilesArtifactName:
         description: 'The name of the deploy files artifact created by the build.'
         value: ${{ jobs.build-and-test.outputs.deployFilesArtifactName }}
@@ -34,10 +40,8 @@ env:
   powerShellModuleName: 'ScriptModuleRepositoryTemplate'
   powerShellModuleDirectoryPath: './src/ScriptModuleRepositoryTemplate'
   deployFilesDirectoryPath: './deploy'
-  prereleaseModuleArtifactName: 'PrereleaseModuleArtifact'
-  prereleaseModuleArtifactDirectoryPath: './artifacts/Prerelease'
-  stableModuleArtifactName: 'StableModuleArtifact'
-  stableModuleArtifactDirectoryPath: './artifacts/Stable'
+  moduleArtifactName: 'ModuleArtifact'
+  moduleArtifactDirectoryPath: './artifacts/Module'
   deployFilesArtifactName: 'DeployFilesArtifact'
   deployFilesArtifactDirectoryPath: './artifacts/deploy'
 
@@ -46,8 +50,10 @@ jobs:
     runs-on: windows-latest # Use Windows agent to ensure dotnet.exe is available to build C# assemblies, if required.
     outputs:
       powerShellModuleName: ${{ env.powerShellModuleName }}
-      prereleaseModuleArtifactName: ${{ env.prereleaseModuleArtifactName }}
-      stableModuleArtifactName: ${{ env.stableModuleArtifactName }}
+      stableVersionNumber: ${{ steps.version-number.outputs.majorMinorPatch }}
+      prereleaseVersionNumber: ${{ steps.version-number.outputs.majorMinorPatch }}-${{ steps.version-number.outputs.prereleaseLabel }}
+      prereleaseVersionLabel: ${{ steps.version-number.outputs.prereleaseLabel}}
+      moduleArtifactName: ${{ env.moduleArtifactName }}
       deployFilesArtifactName: ${{ env.deployFilesArtifactName }}
     steps:
       - name: Checkout the repo source code
@@ -72,6 +78,7 @@ jobs:
         uses: gittools/actions/gitversion/execute@v0
 
       - name: Determine the new version number
+        id: version-number
         shell: pwsh
         run: |
           [string] $newVersionNumber = '${{ steps.git-version.outputs.majorMinorPatch }}'
@@ -91,9 +98,9 @@ jobs:
           # PowerShell prerelease labels can only contain the characters 'a-zA-Z0-9', so sanitize it if needed.
           $newVersionNumberPrereleaseLabel = $prereleaseLabel -replace '[^a-zA-Z0-9]', ''
 
-          Write-Output "Setting new environment variables 'NewVersionNumberMajorMinorPatch=$newVersionNumber' and 'NewVersionNumberPrereleaseLabel=$newVersionNumberPrereleaseLabel'."
-          "NewVersionNumberMajorMinorPatch=$newVersionNumber" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
-          "NewVersionNumberPrereleaseLabel=$newVersionNumberPrereleaseLabel" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+          Write-Output "Setting step output variables 'majorMinorPatch=$newVersionNumber' and 'prereleaseLabel=$newVersionNumberPrereleaseLabel'."
+          "majorMinorPatch=$newVersionNumber" | Out-File -FilePath $Env:GITHUB_OUTPUT -Encoding utf8 -Append
+          "prereleaseLabel=$newVersionNumberPrereleaseLabel" | Out-File -FilePath $Env:GITHUB_OUTPUT -Encoding utf8 -Append
 
       - name: Run PowerShell linter with PSScriptAnalyzer
         shell: pwsh
@@ -132,40 +139,25 @@ jobs:
           min-coverage-overall: 60
           min-coverage-changed-files: 60
 
-      - name: Create Stable and Prerelease module artifacts
+      - name: Create the module artifact
         shell: pwsh
         run: |
           Write-Output "Reading in environment variables."
           [string] $moduleName = $Env:powerShellModuleName
           [string] $moduleDirectoryPath = $Env:powerShellModuleDirectoryPath
           [string] $moduleManifestFileName = $moduleName + '.psd1'
-          [string] $prereleaseArtifactModuleDirectoryPath = Join-Path -Path $Env:prereleaseModuleArtifactDirectoryPath -ChildPath $moduleName
-          [string] $stableArtifactModuleDirectoryPath = Join-Path -Path $Env:stableModuleArtifactDirectoryPath -ChildPath $moduleName
-          [string] $newVersionNumber = $Env:NewVersionNumberMajorMinorPatch
-          [string] $newVersionNumberPrereleaseLabel = $Env:NewVersionNumberPrereleaseLabel
+          [string] $moduleManifestFilePath = Join-Path -Path $moduleDirectoryPath -ChildPath $moduleManifestFileName
+          [string] $moduleArtifactDirectoryPath = Join-Path -Path $Env:moduleArtifactDirectoryPath -ChildPath $moduleName
+          [string] $newVersionNumber = '${{ steps.version-number.outputs.majorMinorPatch}}'
 
-          Write-Output "Copying the module files to the Prerelease artifact directory '$prereleaseArtifactModuleDirectoryPath'."
-          Copy-Item -Path $moduleDirectoryPath -Destination $prereleaseArtifactModuleDirectoryPath -Exclude '*.Tests.ps1' -Recurse -Force
+          Write-Output "Updating the version number of the module manifest file '$moduleManifestFilePath' to '$newVersionNumber'."
+          Update-ModuleManifest -Path $moduleManifestFilePath -ModuleVersion $newVersionNumber
 
-          Write-Output "Copying the module files to the Stable artifact directory '$stableArtifactModuleDirectoryPath'."
-          Copy-Item -Path $moduleDirectoryPath -Destination $stableArtifactModuleDirectoryPath -Exclude '*.Tests.ps1' -Recurse -Force
+          Write-Output "Testing the module manifest file '$moduleManifestFilePath' to ensure it is valid."
+          Test-ModuleManifest -Path $moduleManifestFilePath
 
-          Write-Output "Determining what the module manifest file paths are."
-          [string] $manifestFilePath = Join-Path -Path $moduleDirectoryPath -ChildPath $moduleManifestFileName
-          [string] $prereleaseManifestFilePath = Join-Path -Path $prereleaseArtifactModuleDirectoryPath -ChildPath $moduleManifestFileName
-          [string] $stableManifestFilePath = Join-Path -Path $stableArtifactModuleDirectoryPath -ChildPath $moduleManifestFileName
-
-          Write-Output "Updating the prerelease manifest's version number to '$newVersionNumber-$newVersionNumberPrereleaseLabel'."
-          Update-ModuleManifest -Path $prereleaseManifestFilePath -ModuleVersion $newVersionNumber -Prerelease $newVersionNumberPrereleaseLabel
-
-          Write-Output "Updating the stable manifest's version number to '$newVersionNumber'."
-          Update-ModuleManifest -Path $stableManifestFilePath -ModuleVersion $newVersionNumber
-
-          Write-Output "Testing the Prerelease manifest file '$prereleaseManifestFilePath' to ensure it is valid."
-          Test-ModuleManifest -Path $prereleaseManifestFilePath
-
-          Write-Output "Testing the Stable manifest file '$stableManifestFilePath' to ensure it is valid."
-          Test-ModuleManifest -Path $stableManifestFilePath
+          Write-Output "Copying the module files to the module artifact directory '$moduleArtifactDirectoryPath'."
+          Copy-Item -Path $moduleDirectoryPath -Destination $moduleArtifactDirectoryPath -Exclude '*.Tests.ps1' -Recurse -Force
 
       - name: Create deploy files artifact
         shell: pwsh
@@ -181,7 +173,7 @@ jobs:
         if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
         shell: pwsh
         run: |
-          [string] $newVersionNumber = $Env:NewVersionNumberMajorMinorPatch
+          [string] $newVersionNumber = '${{ steps.version-number.outputs.majorMinorPatch}}'
           [string] $newVersionTag = "v$newVersionNumber"
 
           # To avoid a 403 error on 'git push', ensure you have granted your GitHub Actions workflow read/write permission.
@@ -192,17 +184,11 @@ jobs:
           & git tag $newVersionTag
           & git push origin $newVersionTag
 
-      - name: Upload prerelease module artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ env.prereleaseModuleArtifactName }}
-          path: ${{ env.prereleaseModuleArtifactDirectoryPath }}
-
-      - name: Upload stable module artifact
+      - name: Upload module artifact
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.stableModuleArtifactName }}
-          path: ${{ env.stableModuleArtifactDirectoryPath }}
+          name: ${{ env.moduleArtifactName }}
+          path: ${{ env.moduleArtifactDirectoryPath }}
 
       - name: Upload deploy files artifact
         uses: actions/upload-artifact@v4

.github/workflows/build-test-and-deploy-powershell-module.yml

@@ -26,36 +26,29 @@ jobs:
   publish-prerelease-module:
     needs: run-build-and-test
     runs-on: ubuntu-latest
-    outputs:
-      prereleaseVersionNumber: ${{ steps.output-version-number.outputs.prereleaseVersionNumber }}
     steps:
-      - name: Download prerelease module artifact
+      - name: Download module artifact
         uses: actions/download-artifact@v4
         with:
-          name: ${{ needs.run-build-and-test.outputs.prereleaseModuleArtifactName }}
+          name: ${{ needs.run-build-and-test.outputs.moduleArtifactName }}
           path: ${{ env.artifactsDirectoryPath }}
 
       - name: Publish prerelease PowerShell module
         shell: pwsh
         run: |
           [string] $moduleName = '${{ needs.run-build-and-test.outputs.powerShellModuleName }}'
           [string] $moduleDirectoryPath = "$Env:artifactsDirectoryPath/$moduleName"
-          Publish-Module -Path $moduleDirectoryPath -NuGetApiKey '${{ secrets.POWERSHELL_GALLERY_API_KEY }}' -Verbose
+          [string] $moduleManifestFilePath = Join-Path -Path $moduleDirectoryPath -ChildPath "$moduleName.psd1"
+          [string] $prereleaseVersionLabel = '${{ needs.run-build-and-test.outputs.prereleaseVersionLabel}}'
 
-      - name: Make prerelease version number available to downstream jobs
-        id: output-version-number
-        shell: pwsh
-        run: |
-          [string] $moduleName = '${{ needs.run-build-and-test.outputs.powerShellModuleName }}'
-          [string] $moduleManifestPath = "$Env:artifactsDirectoryPath/$moduleName/$moduleName.psd1"
-          Write-Output "Reading module manifest from '$moduleManifestPath'."
-          [hashtable] $manifest = Get-Content -Path $moduleManifestPath -Raw | Invoke-Expression
-          [string] $versionNumber = $manifest.ModuleVersion
-          [string] $prereleasePostfix = $manifest.PrivateData.PSData.Prerelease
-          [string] $prereleaseVersionNumber = "$versionNumber-$prereleasePostfix"
+          Write-Output "Updating the module manifest version number's prerelease label to '$prereleaseVersionLabel'."
+          Update-ModuleManifest -Path $moduleManifestFilePath -Prerelease $prereleaseVersionLabel
+
+          Write-Output "Testing the prerelease module manifest file '$moduleManifestFilePath' to ensure it is still valid."
+          Test-ModuleManifest -Path $moduleManifestFilePath
 
-          Write-Output "Saving the prerelease version number '$prereleaseVersionNumber' to an output variable."
-          "prereleaseVersionNumber=$prereleaseVersionNumber" | Out-File -FilePath $Env:GITHUB_OUTPUT -Encoding utf8 -Append
+          Write-Output "Publishing the prerelease version of the module."
+          Publish-Module -Path $moduleDirectoryPath -NuGetApiKey '${{ secrets.POWERSHELL_GALLERY_API_KEY }}' -Verbose
 
       - name: Wait a short while for the module to be available on the PowerShell Gallery before continuing
         shell: pwsh
@@ -76,7 +69,7 @@ jobs:
         shell: pwsh
         run: |
           [string] $moduleName = '${{ needs.run-build-and-test.outputs.powerShellModuleName }}'
-          [string] $prereleaseVersionNumber = '${{ needs.publish-prerelease-module.outputs.prereleaseVersionNumber }}'
+          [string] $prereleaseVersionNumber = '${{ needs.run-build-and-test.outputs.prereleaseVersionNumber}}'
 
           Write-Output "Installing the module '$moduleName' prerelease version '$prereleaseVersionNumber' from the PowerShell Gallery."
           Install-Module -Name $moduleName -AllowPrerelease -RequiredVersion $prereleaseVersionNumber -Force -Scope CurrentUser -Repository PSGallery -ErrorAction Stop -Verbose
@@ -117,7 +110,7 @@ jobs:
         shell: powershell
         run: |
           [string] $moduleName = '${{ needs.run-build-and-test.outputs.powerShellModuleName }}'
-          [string] $prereleaseVersionNumber = '${{ needs.publish-prerelease-module.outputs.prereleaseVersionNumber }}'
+          [string] $prereleaseVersionNumber = '${{ needs.run-build-and-test.outputs.prereleaseVersionNumber}}'
 
           Write-Output "Installing the module '$moduleName' prerelease version '$prereleaseVersionNumber' from the PowerShell Gallery."
           Install-Module -Name $moduleName -AllowPrerelease -RequiredVersion $prereleaseVersionNumber -Force -Scope CurrentUser -Repository PSGallery -ErrorAction Stop -Verbose
@@ -150,13 +143,11 @@ jobs:
     needs: [run-build-and-test, test-prerelease-module-in-pwsh, test-prerelease-module-in-windows-powershell]
     runs-on: ubuntu-latest
     environment: production # Used for deployment approvals.
-    outputs:
-      stableVersionNumber: ${{ steps.output-version-number.outputs.StableVersionNumber }}
     steps:
-      - name: Download stable module artifact from triggered workflow
+      - name: Download module artifact from triggered workflow
         uses: actions/download-artifact@v4
         with:
-          name: ${{ needs.run-build-and-test.outputs.stableModuleArtifactName}}
+          name: ${{ needs.run-build-and-test.outputs.moduleArtifactName}}
           path: ${{ env.artifactsDirectoryPath }}
 
       - name: Publish stable PowerShell module
@@ -166,19 +157,6 @@ jobs:
           [string] $moduleDirectoryPath = "$Env:artifactsDirectoryPath/$moduleName"
           Publish-Module -Path $moduleDirectoryPath -NuGetApiKey '${{ secrets.POWERSHELL_GALLERY_API_KEY }}' -Verbose
 
-      - name: Make stable version number available to downstream jobs
-        id: output-version-number
-        shell: pwsh
-        run: |
-          [string] $moduleName = '${{ needs.run-build-and-test.outputs.powerShellModuleName }}'
-          [string] $moduleManifestPath = "$Env:artifactsDirectoryPath/$moduleName/$moduleName.psd1"
-          Write-Output "Reading module manifest from '$moduleManifestPath'."
-          [hashtable] $manifest = Get-Content -Path $moduleManifestPath -Raw | Invoke-Expression
-          [string] $versionNumber = $manifest.ModuleVersion
-
-          Write-Output "Saving the stable version number '$versionNumber' to an output variable."
-          "stableVersionNumber=$versionNumber" | Out-File -FilePath $Env:GITHUB_OUTPUT -Encoding utf8 -Append
-
       - name: Wait a short while for the module to be available on the PowerShell Gallery before continuing
         shell: pwsh
         run: Start-Sleep -Seconds 30
@@ -198,7 +176,7 @@ jobs:
         shell: pwsh
         run: |
           [string] $moduleName = '${{ needs.run-build-and-test.outputs.powerShellModuleName }}'
-          [string] $stableVersionNumber = '${{ needs.publish-stable-module.outputs.stableVersionNumber }}'
+          [string] $stableVersionNumber = '${{ needs.run-build-and-test.outputs.stableVersionNumber}}'
 
           Write-Output "Installing the module '$moduleName' stable version '$stableVersionNumber' from the PowerShell Gallery."
           Install-Module -Name $moduleName -RequiredVersion $stableVersionNumber -Force -Scope CurrentUser -Repository PSGallery -ErrorAction Stop -Verbose
@@ -239,7 +217,7 @@ jobs:
         shell: powershell
         run: |
           [string] $moduleName = '${{ needs.run-build-and-test.outputs.powerShellModuleName }}'
-          [string] $stableVersionNumber = '${{ needs.publish-stable-module.outputs.stableVersionNumber }}'
+          [string] $stableVersionNumber = '${{ needs.run-build-and-test.outputs.stableVersionNumber}}'
 
           Write-Output "Installing the module '$moduleName' stable version '$stableVersionNumber' from the PowerShell Gallery."
           Install-Module -Name $moduleName -RequiredVersion $stableVersionNumber -Force -Scope CurrentUser -Repository PSGallery -ErrorAction Stop -Verbose