kovagoadi/hunfabric
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix changelog categorization and enhance script (#3955)

Browse Source 
* Fix categorization of PR #3949 in CHANGELOG.md

* Enhance changelog.py to error on uncategorized PRs

* Update skill to propose breaking changes to user
This commit is contained in:
Ludovico Magnocavallo
2026-05-10 19:15:16 +02:00
committed by GitHub
parent 019d4143c1
commit 5d57658e36
4 changed files with 27 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
skills/maintenance/release-process/SKILL.md
View File

@@ -97,29 +97,38 @@ You can create the release either automatically via the GitHub CLI or manually v
### Option A: Automated via GitHub CLI (Recommended)
This script extracts any "BREAKING CHANGES" from the changelog, converts the heading to Title Case, and prepends them to the automatically generated release notes.
This script extracts any "BREAKING CHANGES" from the changelog and converts the heading to Title Case.
```bash
# 1. Extract the section for the new release from CHANGELOG.md
# We use awk to grab everything from the new release header until the next release header
RELEASE_NOTES=$(awk "/^## \[$NEW_RELEASE\]/{flag=1; next} /^## \[v/{flag=0} flag" CHANGELOG.md)
RELEASE_NOTES=$(awk "/^## \[v$NEW_RELEASE\]/{flag=1; next} /^## \[v/{flag=0} flag" CHANGELOG.md)
# 2. Extract just the BREAKING CHANGES section (if any)
BREAKING_CHANGES=$(echo "$RELEASE_NOTES" | awk '/^### BREAKING CHANGES/{flag=1; print; next} /^### /{flag=0} flag')
# 3. Create the release
# 3. Format breaking changes
if [ -n "$(echo "$BREAKING_CHANGES" | tr -d '[:space:]')" ]; then
# Convert "### BREAKING CHANGES" to "### Breaking Changes"
FORMATTED_BREAKING_CHANGES=$(echo "$BREAKING_CHANGES" | sed 's/^### BREAKING CHANGES/### Breaking Changes/')
# Prepend breaking changes to the generated notes
gh release create "$NEW_RELEASE" --title "$NEW_RELEASE" --generate-notes --notes "$FORMATTED_BREAKING_CHANGES"
else
# Otherwise, just generate the standard notes
gh release create "$NEW_RELEASE" --title "$NEW_RELEASE" --generate-notes
echo "$FORMATTED_BREAKING_CHANGES"
fi
```
> **CRITICAL:** Show the extracted and formatted breaking changes to the user and wait for their approval before proceeding to create the release.
Once approved, run the appropriate command to create the release.
If there were breaking changes:
```bash
gh release create "$NEW_RELEASE" --title "$NEW_RELEASE" --generate-notes --notes "$FORMATTED_BREAKING_CHANGES"
```
If there were no breaking changes:
```bash
gh release create "$NEW_RELEASE" --title "$NEW_RELEASE" --generate-notes
```
### Option B: Manual via GitHub UI
Go to the [GitHub Releases UI](https://github.com/GoogleCloudPlatform/cloud-foundation-fabric/releases/new) and configure the release: