Skip to content

fix(release): preserve aqua-registry sections in changelog across releases #8047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdx merged 1 commit into from
Feb 7, 2026
Merged

fix(release): preserve aqua-registry sections in changelog across releases #8047

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion xtasks/release-plz
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,9 @@ AQUA_CHANGELOG_PR="$(./scripts/gen-aqua-changelog.sh "$OLD_AQUA_PKGS" "$NEW_AQUA

# Generate changelog using git-cliff with explicit calver version (not --bump which uses semver)
# LLM editorialization happens in release.yml after merge
git cliff --tag "v$version" -o CHANGELOG.md
# Use --unreleased --prepend to only add the new release entry, preserving existing content
# (including previously injected aqua-registry sections from older releases)
git cliff --tag "v$version" --unreleased --prepend CHANGELOG.md

Copilot AI Feb 7, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git cliff previously wrote to CHANGELOG.md via -o CHANGELOG.md, but the updated command relies on --prepend CHANGELOG.md without an explicit output flag or redirection. In many git-cliff versions, --prepend affects how output is combined with an existing file but does not itself imply an output destination, which can result in the changelog being printed to stdout instead of updating CHANGELOG.md. To make the behavior unambiguous, write explicitly (e.g., add -o CHANGELOG.md and keep --prepend CHANGELOG.md, or redirect stdout to CHANGELOG.md if that matches the intended semantics).

Suggested change
git cliff --tag "v$version" --unreleased --prepend CHANGELOG.md
git cliff --tag "v$version" --unreleased --prepend CHANGELOG.md -o CHANGELOG.md

Copilot uses AI. Check for mistakes.

# Get the unreleased notes for PR body (strip version header since PR title has version)
PR_NOTES="$(git cliff --tag "v$version" --unreleased --strip all | tail -n +3)"
Expand All @@ -290,6 +292,7 @@ if [[ -n $AQUA_CHANGELOG_MD ]]; then
if (release_count == 1 && !inserted) {
# We are at the second release, inject aqua section before it
print ENVIRON["AQUA_CHANGELOG_MD"]
print ""
inserted = 1
}
release_count++
Expand All @@ -298,6 +301,7 @@ if [[ -n $AQUA_CHANGELOG_MD ]]; then
END {
# If we never hit a second release (only one release in file), append at end
if (release_count == 1 && !inserted) {
print ""
print ENVIRON["AQUA_CHANGELOG_MD"]
}
}
Expand Down
Loading