From ea1f0443ece06c2c107d08af2c060e469288ff41 Mon Sep 17 00:00:00 2001
From: Jesse Squire <jesse.squire@gmail.com>
Date: Mon, 7 Jul 2025 15:50:19 -0700
Subject: [PATCH] [Workflow] Release Notes => Change Log

The focus of these changes is to update the release process to explicitly point the "Release Notes" on the GH release page to the change log for the release.  This will ensure that default content is not generated, and we have one consistent source of truth for the changes in a release.
---
 .github/workflows/release.yml | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 4d28b2e85..6285b9cfc 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,5 +1,5 @@
 # This workflow is triggered by new releases and on a daily schedule.
-# It builds, unit tests, live tests and published the Open AI nuget package.
+# It builds, unit tests, live tests and publishes the Open AI NuGet package.
 # For daily runs, the package is published to the GitHub package registry.
 # For releases, the package is published to the NuGet package registry.
 name: Release package
@@ -11,6 +11,10 @@ on:
     # run every day at 00:00
     - cron: '0 0 * * *'
 
+permissions:
+  contents: write
+  packages: write
+
 jobs:
   build:
     name: Build
@@ -18,9 +22,6 @@ jobs:
     environment: Live Testing
     env:
       version_suffix_args: ${{ github.event_name == 'schedule' && format('/p:VersionSuffix="alpha.{0}"', github.run_number) || '' }}
-    permissions:
-      packages: write
-      contents: write
     steps:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
@@ -30,7 +31,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      # Pack the client nuget package and include url back to the repository and release tag
+      # Pack the client NuGet package and include URL back to the repository and release tag
       - name: Build and Pack
         run: dotnet pack
           --configuration Release
@@ -81,6 +82,12 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Update GitHub release notes to point to the changelog
+        if: github.event_name == 'release'
+        run: |
+          gh release edit "${{ github.event.release.tag_name }}" \
+            --notes "See full changelog: ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.event.release.tag_name }}/CHANGELOG.md"
+
       - name: NuGet authenticate
         run: dotnet nuget add source
           "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json"
@@ -91,7 +98,7 @@ jobs:
 
       - name: Publish package to local feed
         run: dotnet nuget push
-            ${{github.workspace}}/build-artifacts/packages/*.nupkg
+            ${{ github.workspace }}/build-artifacts/packages/*.nupkg
             --source "github"
             --api-key ${{ secrets.GITHUB_TOKEN }}
             --skip-duplicate
@@ -99,7 +106,7 @@ jobs:
       - name: Publish package to nuget.org
         if: github.event_name == 'release'
         run: dotnet nuget push
-            ${{github.workspace}}/build-artifacts/packages/*.nupkg
+            ${{ github.workspace }}/build-artifacts/packages/*.nupkg
             --source https://api.nuget.org/v3/index.json
             --api-key ${{ secrets.NUGET_API_KEY }}
             --skip-duplicate