👶 Initial add of PSModule publishing workflow

Author: mtboren

.github/workflows/PublishPSModuleToGallery.yaml

@@ -0,0 +1,86 @@
+name: Publish PowerShell Module
+
+on:
+  push:
+    paths:
+      - 'vN.AWSSSO/**'
+  release:
+    types: [released]
+  workflow_dispatch:
+    inputs:
+      GHDeploymentEnv:
+        description: 'GH Deployment Environment to use for this workflow run'
+        required: true
+        default: 'Dev'
+        type: choice
+        options:
+          - dev
+          - bogus_for_failure_testing
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  publish-module:
+    name: 🧾 Publish Module
+    runs-on: ubuntu-latest
+    ## if the event is a release, then the GHDeploymentEnv is prod, else if workflow_dispatch, then use the input, else dev
+    environment: ${{ github.event_name == 'release' && 'prod' || (github.event_name == 'workflow_dispatch' && github.event.inputs.GHDeploymentEnv || 'dev') }}
+    steps:
+      - name: 🌿 Checkout repository (ref '${{ github.ref_name }}')
+        uses: actions/checkout@v5
+
+      - name: Ensure given PS Gallery is registered ('${{ vars.PSGALLERY_URI }}')
+        run: |
+          if (-not ($oExistingPSResRepoRegistration = Get-PSResourceRepository -Name '${{ vars.PSGALLERY_DISPLAYNAME }}' -ErrorAction:SilentlyContinue)) {
+            Write-Verbose -Verbose "PSResource Repository '${{ vars.PSGALLERY_DISPLAYNAME }}' (URL '${{ vars.PSGALLERY_URI }}') is not registered. Registering now"
+            $hshParamForRegisterPSRepository = @{
+              Name = '${{ vars.PSGALLERY_DISPLAYNAME }}'
+              URI = '${{ vars.PSGALLERY_URI }}'
+              ErrorAction = "Stop"
+              Verbose = $true
+            }
+            Register-PSResourceRepository @hshParamForRegisterPSRepository
+          }
+          else {
+            Write-Verbose -Verbose "PSResource Repository '${{ vars.PSGALLERY_DISPLAYNAME }}' is already registered (URL '$($oExistingPSResRepoRegistration.Uri)'). Skipping registration."
+          }
+
+      - name: 📦 Publish module to PSGallery
+        id: publish_ps_module
+        run: |
+          Get-ChildItem -Path . -Recurse -Filter *.psd1 | ForEach-Object {
+            Write-Verbose -Verbose "Found module manifest: '$($_.FullName)'"
+            try {
+              Test-ModuleManifest -Path $_.FullName -ErrorAction:Stop
+              $hshParamForPublishPSResource = @{
+                ApiKey = '${{ secrets.PSGALLERY_APIKEY }}'
+                Repository = '${{ vars.PSGALLERY_DISPLAYNAME }}'
+                Path = $_.FullName
+                ErrorAction = "Stop"
+                Verbose = $true
+              }
+              Publish-PSResource @hshParamForPublishPSResource
+            }
+            ## throw the error if any, so future steps know outcome
+            catch {throw $_}
+          }
+
+      - name: 📝 Write summary of publishing
+        if: always()
+        run: |
+          $strResultOfPublish = switch ('${{ steps.publish_ps_module.outcome }}') {
+            "success" {"✅ Succeeded"}
+            "failure" {"😡 Failed"}
+            "cancelled" {"❌ Canceled"}
+            "skipped" {"🦘 Skipped"}
+          }
+          Add-Content -Path $GITHUB_STEP_SUMMARY -Encoding utf8 -Value @"
+          # Publish Summary
+          | What | Value |
+          |------|-------|
+          Module | ${{ steps.get-module-version.outputs.module-name }}
+          Version | ${{ steps.get-module-version.outputs.module-version }}
+          Result | $strResultOfPublish
+          "@

.github/workflows/ReadMe.md

@@ -0,0 +1,20 @@
+# GitHub Workflows
+Info about the GitHub Actions workflows here
+
+## 📦 PublishPSModuleToGallery
+For publishing a PowerShell module to the corresponding PSResourceRepository. Has some logic to publish to dev/prod PSResourceRepo based on the triggering event, like a GitHub Release, or a direct workflow invocation.
+
+GitHub Deployment Environment info for variables / secrets for this workflow:
+
+### Variables
+
+| Variable | Example Value | Description |
+| -------- | ------------- | ----------- |
+PSGALLERY_DISPLAYNAME | `PSGallery` | Value to use a display name of PSResource Repo that will be temporarily registered in the runner, and to which to publish the PowerShell module
+PSGALLERY_URI | https://www.powershellgallery.com/api/v2 | URI of target PS Resource repository to which to publish PowerShell module
+
+### Secrets
+
+| Secret | Example Value | Description |
+| ------ | ------------- | ----------- |
+PSGALLERY_APIKEY | `mysuperAPIKey-70821435-764a-4e6a-a397-9a48977be13b` | API key that provides write rights to the given PS Resource reposity (like myget.org or powershellgallery.com)