🦠 fix(ci): release PR body shows previous release changelog

[UniquePixels]

Summary

The ci-release.yml workflow populates the release PR description with the previous release's changelog instead of the current one.

Root Cause

In the create-release-pr job, the PR body is generated at line 128:

BODY=$(git-cliff --latest --strip header)

This runs after the release commit (line 125), but --latest resolves against existing tags. Since the new tag hasn't been created yet (that happens in tag-release after merge), --latest picks up the previous release (e.g. v0.1.0 instead of v0.1.1).

Meanwhile, the changelog file itself is generated correctly at line 84 using --tag "v${RELEASE_VERSION}", which tells git-cliff to treat the new version as if it were already tagged.

Fix

Use the same --tag flag for the PR body generation:

BODY=$(git-cliff --tag "v${RELEASE_VERSION}" --latest --strip header)

This tells git-cliff to consider the new version tag when resolving --latest, producing the correct changelog for the current release.

Impact

PR #24 (v0.1.1) was affected — the body showed v0.1.0 changes. Manually corrected.

[coderabbitai]

Coding Plan

Summary

• Apply a single-line fix that adds --tag "v${RELEASE_VERSION}" to the existing git-cliff command at line 128
• This reuses the established pattern from line 84 where the same flag is used for CHANGELOG.md generation
• No additional environment variables or structural changes are needed since RELEASE_VERSION is already available in scope

Implementation Steps

Fix PR Body Changelog Generation

This phase addresses the root cause by aligning the PR body generation command with the pattern already established for CHANGELOG.md generation. The fix ensures git-cliff recognizes the new version when resolving --latest.

Add Version Tag Flag to PR Body Generation Command

Update the git-cliff command used for PR body generation to include the --tag flag, matching the approach already used for CHANGELOG.md generation.

• Modify .github/workflows/ci-release.yml at line 128 within the "Create release branch and PR" step
• Change the command from git-cliff --latest --strip header to git-cliff --tag "v${RELEASE_VERSION}" --latest --strip header
• The RELEASE_VERSION environment variable is already available in this step's context, so no additional variable declarations are needed
• This mirrors the pattern used at line 84 where --tag "v${RELEASE_VERSION}" is used for full changelog generation

🤖 Prompt for AI agents

Fix the PR body changelog generation in `.github/workflows/ci-release.yml` by
adding the `--tag` flag to the git-cliff command so it correctly recognizes the
upcoming version tag.

- In `.github/workflows/ci-release.yml` at line 128 within the "Create release
branch and PR" step, update the git-cliff command:
  - **Before:** `git-cliff --latest --strip header`
  - **After:** `git-cliff --tag "v${RELEASE_VERSION}" --latest --strip header`
- No other changes are needed — `RELEASE_VERSION` is already available in this
step's environment scope, and this change mirrors the existing pattern used at
line 84 for CHANGELOG.md generation

Research

The ci-release.yml workflow manages the release process through two jobs: create-release-pr (triggered manually) and tag-release (triggered on merge to main). The workflow uses git-cliff in multiple places with varying flags. Notably, the RELEASE_VERSION environment variable is already available and correctly used throughout the create-release-pr job, including for changelog file generation at line 84 where --tag "v${RELEASE_VERSION}" is properly applied.

---

🚀 Next Steps

🤖 All AI agent prompts combined

Fix the PR body changelog generation in `.github/workflows/ci-release.yml` by
adding the `--tag` flag to the git-cliff command so it correctly recognizes the
upcoming version tag.

- In `.github/workflows/ci-release.yml` at line 128 within the "Create release
branch and PR" step, update the git-cliff command:
  - **Before:** `git-cliff --latest --strip header`
  - **After:** `git-cliff --tag "v${RELEASE_VERSION}" --latest --strip header`
- No other changes are needed — `RELEASE_VERSION` is already available in this
step's environment scope, and this change mirrors the existing pattern used at
line 84 for CHANGELOG.md generation

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[coderabbitai]

🔗 Related PRs

#8 - 🦠 fix(qa): detect all Biome finding severities as failures [merged]
#10 - 🌈 improve(config): add Renovate commit format and squash strategy [merged]
#21 - 🌈 improve(readme): revamp badge row [merged]

---

📝 Issue Planner

_{Check the box below or use the @coderabbitai plan command to generate an implementation plan and prompts that you can use with your favorite coding assistant.}

• Create Plan

---

🧪 Issue enrichment is currently in open beta.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord!