Publish to GitHub releases in publish.yml

Author: PhysShell

.github/workflows/publish.yml

@@ -6,6 +6,9 @@ on:
     tags:
       - 'v*'
 
+permissions:
+  contents: write
+
 jobs:
   publish:
     runs-on: windows-latest
@@ -41,6 +44,7 @@ jobs:
           }
 
       - name: Validate and Stage Release Notes
+        id: module_meta
         shell: pwsh
         run: |
           $manifestPath = Resolve-Path -LiteralPath .\git-aliases-extra.psd1 |
@@ -54,6 +58,10 @@ jobs:
           }
 
           Update-ModuleManifest -Path $manifestPath -ReleaseNotes $releaseNotes
+          $releaseNotesPath = Join-Path $env:RUNNER_TEMP ("release-notes-{0}.md" -f $moduleVersion)
+          Set-Content -LiteralPath $releaseNotesPath -Value $releaseNotes -Encoding utf8
+          "module_version=$moduleVersion" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append
+          "release_notes_path=$releaseNotesPath" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append
           Write-Host "Release notes for version '$moduleVersion' loaded from CHANGELOG.md."
 
       - name: Prepare Publish Layout
@@ -90,3 +98,12 @@ jobs:
           }
 
           Publish-Module -Path $publishPath -Repository PSGallery -NuGetApiKey $env:PSGALLERY_API_KEY -ErrorAction Stop
+
+      - name: Create or Update GitHub Release
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          body_path: ${{ steps.module_meta.outputs.release_notes_path }}
+          generate_release_notes: false

README.md

@@ -282,14 +282,18 @@ Checks are skipped when:
 This repository includes:
 
 - `.github/workflows/ci.yml` for lint + tests
-- `.github/workflows/publish.yml` for PSGallery publishing
+- `.github/workflows/publish.yml` for PSGallery publish + GitHub Release creation
 
 To publish from CI:
 
 1. Add repository secret `PSGALLERY_API_KEY`.
 2. Add release notes to `CHANGELOG.md` under `## [<ModuleVersion>] - YYYY-MM-DD`.
 3. Bump `ModuleVersion` in `git-aliases-extra.psd1`.
-4. Push a tag `v<ModuleVersion>` (for example, `v0.1.0`) or run the publish workflow manually.
+4. Push a tag `v<ModuleVersion>` (for example, `v0.1.1`) or run the publish workflow manually.
+
+On tag push, the publish workflow does both:
+- publishes the module to PSGallery;
+- creates/updates GitHub Release for the same tag using notes from `CHANGELOG.md`.
 
 ## What CI checks
 

tests/git-aliases-extra.Module.Tests.ps1

@@ -72,6 +72,13 @@ Describe 'git-aliases-extra tooling' {
         (Test-Path -LiteralPath (Join-Path $script:RepoRoot 'tools\prepare-publish.ps1')) | Should -BeTrue
     }
 
+    It 'publishes GitHub release from publish workflow' {
+        $workflowPath = Join-Path $script:RepoRoot '.github\workflows\publish.yml'
+        $workflowText = Get-Content -LiteralPath $workflowPath -Raw
+        $workflowText | Should -Match 'Create or Update GitHub Release'
+        $workflowText | Should -Match 'softprops/action-gh-release@v2'
+    }
+
     It 'resolves release notes from changelog for manifest version' {
         $manifest = Test-ModuleManifest -Path $script:ModuleManifest -ErrorAction Stop
         $version = $manifest.Version.ToString()