ci: validate changelog fragment filenames (#4586)

* ci: validate changelog fragment filenames

Extend the existing fragment-existence check so it also rejects fragments
whose basename doesn't match <PR_NUMBER>.<type> (where type is one of
added, changed, deprecated, removed, fixed). This catches typos in the
PR number or in the fragment type that would otherwise render a wrong
PR link, or be silently dropped, in the rendered changelog.

Also note in the do-not-edit comment of each towncrier-managed CHANGELOG.md
(root and the 4 independent packages) that the existing static "## Unreleased"
entries pre-date towncrier and must be folded into the first towncrier-built
release manually — towncrier inserts new release blocks above that section
without merging.

Assisted-by: Claude Opus 4.7 (1M context)

* Update CHANGELOG.md

* Update pyproject.toml

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

---------

Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>

Author: MikeGoldsmith

.github/workflows/changelog.yml

@@ -41,13 +41,15 @@ jobs:
           fi
 
       - name: Check for changelog fragment
+        env:
+          PR_NUMBER: ${{ github.event.pull_request.number }}
         run: |
           # Check for any new fragment files in any .changelog/ directory
           fragments=$(git diff --diff-filter=A --name-only FETCH_HEAD -- '**/.changelog/*' '.changelog/*' | grep -v '.gitignore' || true)
           if [[ -z "$fragments" ]]; then
             echo "No changelog fragment found for this PR."
             echo ""
-            echo "Add a file named .changelog/${{ github.event.pull_request.number }}.<type>"
+            echo "Add a file named .changelog/${PR_NUMBER}.<type>"
             echo "where <type> is one of: added, changed, deprecated, removed, fixed"
             echo ""
             echo "For coordinated packages, add to the root .changelog/ directory."
@@ -57,6 +59,24 @@ jobs:
             echo "Or add the \"Skip Changelog\" label if this job should be skipped."
             exit 1
           fi
+          invalid=()
+          while IFS= read -r f; do
+            base=$(basename "$f")
+            if [[ ! "$base" =~ ^([0-9]+)\.(added|changed|deprecated|removed|fixed)$ ]]; then
+              invalid+=("$f (expected <PR_NUMBER>.<type>; type one of added, changed, deprecated, removed, fixed)")
+              continue
+            fi
+            if [[ "${BASH_REMATCH[1]}" != "${PR_NUMBER}" ]]; then
+              invalid+=("$f (PR number ${BASH_REMATCH[1]} does not match this PR's number ${PR_NUMBER})")
+            fi
+          done <<< "$fragments"
+          if (( ${#invalid[@]} > 0 )); then
+            echo "Invalid changelog fragment(s):"
+            for msg in "${invalid[@]}"; do
+              echo "  $msg"
+            done
+            exit 1
+          fi
           echo "Found changelog fragment(s):"
           echo "$fragments"
 

pyproject.toml

@@ -249,6 +249,7 @@ issue_format = "[#{issue}](https://github.com/open-telemetry/opentelemetry-pytho
 wrap = true
 issue_pattern = "^(\\d+)"
 
+# NOTE: remember to update the changelog workflow if these types change 
 [[tool.towncrier.type]]
 directory = "added"
 name = "Added"