Skip to content

fix: regenerate changelog after tagging in release #54

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
satyaborg merged 1 commit into from
Jun 9, 2026
+12 −3
Merged

fix: regenerate changelog after tagging in release #54

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
15 changes: 12 additions & 3 deletions scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,9 @@ release_main() {
printf '%s\n' "note: actual release requires a clean working tree"
fi
printf '%s\n' "would run bash scripts/devloop_test.sh"
printf '%s\n' "would update VERSION and CHANGELOG.md"
printf 'would commit: chore: release %s\n' "$version"
printf 'would tag: %s\n' "$tag"
printf '%s\n' "would regenerate CHANGELOG.md from tagged history, amend the release commit, and move the tag"
if [ "$publish" = true ] || [ "$push" = true ]; then printf '%s\n' "would push branch and tag"; fi
if [ "$publish" = true ]; then
printf 'would build release assets: devloop-%s.tar.gz and devloop-%s.tar.gz.sha256\n' "$version" "$version"
Expand All @@ -246,10 +246,19 @@ release_main() {

bash "$ROOT/scripts/devloop_test.sh"
printf '%s\n' "$version" > "$ROOT/VERSION"
git-cliff --config "$ROOT/cliff.toml" --workdir "$ROOT" --tag "$tag" --output "$ROOT/CHANGELOG.md"
git -C "$ROOT" add VERSION CHANGELOG.md
git -C "$ROOT" add VERSION
git -C "$ROOT" commit -m "chore: release $version"
git -C "$ROOT" tag -a "$tag" -m "devloop $version"
# Regenerate the changelog after the tag exists and render from the tagged
# history. Two git-cliff (2.x) footguns to avoid: passing --workdir with an
# absolute path breaks its detection that HEAD is tagged and collapses the file
# to a single empty "Unreleased" header, and --tag for a version it treats as
# new truncates the same way. So run from $ROOT without --workdir or --tag,
# then fold the result into the release commit and move the tag onto it.
( cd "$ROOT" && git-cliff --config "$ROOT/cliff.toml" --output "$ROOT/CHANGELOG.md" )
git -C "$ROOT" add CHANGELOG.md
git -C "$ROOT" commit --amend --no-edit
git -C "$ROOT" tag -f -a "$tag" -m "devloop $version"

if [ "$publish" = true ] || [ "$push" = true ]; then
branch="$(release_current_branch)"
Expand Down
Loading