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

docs: update release-process skill to use H2 for breaking changes

Browse Source
This commit is contained in:
Ludovico Magnocavallo
2026-05-25 15:50:30 +00:00
parent 8e0826a95e
commit f44d633311
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -109,8 +109,8 @@ BREAKING_CHANGES=$(echo "$RELEASE_NOTES" | awk '/^### BREAKING CHANGES/{flag=1;
# 3. Format breaking changes # 3. Format breaking changes
if [ -n "$(echo "$BREAKING_CHANGES" | tr -d '[:space:]')" ]; then if [ -n "$(echo "$BREAKING_CHANGES" | tr -d '[:space:]')" ]; then
# Convert "### BREAKING CHANGES" to "### Breaking Changes" # Convert "### BREAKING CHANGES" to "## Breaking Changes"
FORMATTED_BREAKING_CHANGES=$(echo "$BREAKING_CHANGES" | sed 's/^### BREAKING CHANGES/### Breaking Changes/') FORMATTED_BREAKING_CHANGES=$(echo "$BREAKING_CHANGES" | sed 's/^### BREAKING CHANGES/## Breaking Changes/')
echo "$FORMATTED_BREAKING_CHANGES" echo "$FORMATTED_BREAKING_CHANGES"
fi fi
``` ```
@@ -136,6 +136,6 @@ Go to the [GitHub Releases UI](https://github.com/GoogleCloudPlatform/cloud-foun
1. **Tag:** Create a new tag matching the new version (e.g., `v56.0.0`). 1. **Tag:** Create a new tag matching the new version (e.g., `v56.0.0`).
2. **Title:** Use the exact same version string as the tag. 2. **Title:** Use the exact same version string as the tag.
3. **Release Notes:** Click the **"Generate release notes"** button. 3. **Release Notes:** Click the **"Generate release notes"** button.
4. **Breaking Changes:** If the `CHANGELOG.md` contains a "BREAKING CHANGES" section for this release, copy it, paste it at the **top** of the generated release notes, and change the heading to "Breaking Changes". 4. **Breaking Changes:** If the `CHANGELOG.md` contains a "BREAKING CHANGES" section for this release, copy it, paste it at the **top** of the generated release notes, and change the heading to "## Breaking Changes".
Click **Publish release**. Click **Publish release**.