Automate release notes (#1523)

* add workflow that updates repository RELEASENOTES

Author: alinpahontu2912

.github/workflows/test.yml

@@ -0,0 +1,153 @@
+name: Update RELEASENOTES.md
+
+on:
+  pull_request:
+    types: [closed]
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  update-releasenotes:
+    if: >-
+      github.event.pull_request.merged == true &&
+      !contains(github.event.pull_request.labels.*.name, 'skip-changelog')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+
+      - name: Compute next patch version
+        id: version
+        shell: bash
+        run: |
+          FILE="RELEASENOTES.md"
+          LATEST=$(grep -oP '(?<=^# NuGet Version )\d+\.\d+\.\d+' "$FILE" | head -1)
+          if [ -z "$LATEST" ]; then
+            echo "::error::Could not find any version heading in RELEASENOTES.md"
+            exit 1
+          fi
+          MAJOR=$(echo "$LATEST" | cut -d. -f1)
+          MINOR=$(echo "$LATEST" | cut -d. -f2)
+          PATCH=$(echo "$LATEST" | cut -d. -f3)
+          NEXT_PATCH=$((PATCH + 1))
+          NEXT_VERSION="${MAJOR}.${MINOR}.${NEXT_PATCH}"
+          echo "latest=$LATEST" >> "$GITHUB_OUTPUT"
+          echo "next=$NEXT_VERSION" >> "$GITHUB_OUTPUT"
+          echo "Detected latest version: $LATEST → next: $NEXT_VERSION"
+
+      - name: Determine category from labels
+        id: category
+        shell: bash
+        run: |
+          LABELS='${{ toJson(github.event.pull_request.labels.*.name) }}'
+          if echo "$LABELS" | grep -qiE '"breaking-change"'; then
+            echo "section=__Breaking Changes__" >> "$GITHUB_OUTPUT"
+          elif echo "$LABELS" | grep -qiE '"bug"|"fix"'; then
+            echo "section=__Bug Fixes__" >> "$GITHUB_OUTPUT"
+          elif echo "$LABELS" | grep -qiE '"enhancement"|"api-change"|"Missing Feature"'; then
+            echo "section=__API Changes__" >> "$GITHUB_OUTPUT"
+          elif echo "$LABELS" | grep -qiE '"build"|"ci"|"infra"'; then
+            echo "section=__Build/Infrastructure__" >> "$GITHUB_OUTPUT"
+          elif echo "$LABELS" | grep -qiE '"issue-fixed"'; then
+            echo "section=__Issues Fixed__" >> "$GITHUB_OUTPUT"
+          else
+            echo "section=__Other Changes__" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Update RELEASENOTES.md
+        shell: bash
+        env:
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          PR_TITLE: ${{ github.event.pull_request.title }}
+          SECTION: ${{ steps.category.outputs.section }}
+          NEXT_VERSION: ${{ steps.version.outputs.next }}
+        run: |
+          FILE="RELEASENOTES.md"
+          ENTRY="#${PR_NUMBER} ${PR_TITLE}<br/>"
+          VERSION_HEADER="# NuGet Version ${NEXT_VERSION}"
+
+          python3 - "$FILE" "$VERSION_HEADER" "$SECTION" "$ENTRY" <<'PYEOF'
+          import sys
+
+          file_path, ver_header, section, entry = sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4]
+
+          with open(file_path, 'r') as f:
+              content = f.read()
+              lines = content.splitlines(keepends=True)
+
+          # Step 1: If the next version heading doesn't exist, insert it before the first existing one
+          if ver_header not in content:
+              result = []
+              inserted = False
+              for line in lines:
+                  if not inserted and line.startswith('# NuGet Version '):
+                      result.append(ver_header + '\n')
+                      result.append('\n')
+                      inserted = True
+                  result.append(line)
+              if not inserted:
+                  result.append('\n' + ver_header + '\n\n')
+              lines = result
+
+          # Step 2: Find the version block and insert the entry
+          result = []
+          in_version_block = False
+          section_found = False
+          inserted = False
+
+          for i, line in enumerate(lines):
+              stripped = line.rstrip('\n')
+
+              if stripped == ver_header:
+                  in_version_block = True
+                  result.append(line)
+                  continue
+
+              if in_version_block and stripped.startswith('# NuGet Version ') and stripped != ver_header:
+                  # Reached next version block without finding/creating section
+                  if not inserted:
+                      result.append('\n' + section + ':\n\n' + entry + '\n')
+                      inserted = True
+                  in_version_block = False
+                  result.append(line)
+                  continue
+
+              if in_version_block and not inserted and stripped == section + ':':
+                  section_found = True
+                  result.append(line)
+                  continue
+
+              if section_found and not inserted:
+                  # Insert after the blank line following the section heading
+                  if stripped == '':
+                      result.append(line)
+                      result.append(entry + '\n')
+                      inserted = True
+                      continue
+
+              result.append(line)
+
+          # If we reached EOF still inside the version block
+          if in_version_block and not inserted:
+              result.append('\n' + section + ':\n\n' + entry + '\n')
+
+          with open(file_path, 'w') as f:
+              f.writelines(result)
+          PYEOF
+
+      - name: Commit and push
+        shell: bash
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add RELEASENOTES.md
+          if git diff --cached --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "docs: add PR #${{ github.event.pull_request.number }} to RELEASENOTES.md [skip ci]"
+            git push
+          fi

CONTRIBUTING.md

@@ -25,7 +25,7 @@ If you send us a PR, whether for documentation, examples, or library code, we re
 * **DO** refer to any relevant issues, and include [keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) that automatically close issues when the PR is merged.
 * **DO** tag any users that should know about and/or review the change.
 * **DO** ensure each commit successfully builds.  The entire PR must pass all tests in the Continuous Integration (CI) system before it'll be merged.
-* **DO** add a brief description to the RELEASENOTES.md file at the top under the heading of the upcoming release.
+* **DO** label your PR so it appears in the correct release-note category (see the PR template for the label table). Release notes are generated automatically — you do not need to edit `RELEASENOTES.md`.
 * **DO** address PR feedback in an additional commit(s) rather than amending the existing commits, and only rebase/squash them when necessary.  This makes it easier for reviewers to track changes.
 * **DO** assume that ["Squash and Merge"](https://github.com/blog/2141-squash-your-commits) will be used to merge your commit unless you request otherwise in the PR.
 * **DO NOT** fix merge conflicts using a merge commit. Prefer `git rebase`.