Uh oh!
There was an error while loading. Please reload this page.
fix(ci): plumb semantic-release notes into GitHub Release body - #5317
Merged
Conversation
The plan job in release.yml runs cycjimmy/semantic-release-action in dry-run mode purely to compute the next version, never reading new_release_notes, and softprops/action-gh-release in release-shared.yml gets no body. The result: GH Releases since the monorepo move publish with empty bodies (e.g. v2.100.1). A subsequent change will plumb release notes through the production publish path. This commit lands the prerequisites only: - apps/cli/package.json: add @semantic-release/release-notes-generator to release.plugins. It's a default semantic-release plugin bundled in cycjimmy/semantic-release-action's image, so no devDep is needed. Without this, new_release_notes would be empty even after wiring. - .github/workflows/backfill-release-notes.yml: workflow_dispatch with tag and apply inputs. Re-stages the repo on develop/main at the tag's commit (without the tag, so semantic-release computes it as the next release), asserts the computed version matches the tag, dumps the notes to the job summary, and only updates the GH Release body when apply=true. Lets us validate the changelog format end-to-end against an existing tag before touching the production publish path, and doubles as a fix-forward tool for releases that ship with an empty body (e.g. v2.100.1, the recent betas, or any future workflow_dispatch re-cut).
Stage A (#prior PR) added @semantic-release/release-notes-generator to the plugin chain and a manual backfill workflow to validate the format. This change wires the same notes into the production release pipeline so future releases on develop/main come with a populated GH Release body instead of an empty page. - release.yml: capture new_release_notes from the plan job's cycjimmy/semantic-release-action step into a release_notes job output using a heredoc with a random delimiter. SR_NOTES is passed via env and emitted with printf (not echo) so attacker-influenced commit bodies / PR titles can't be interpolated as shell. The workflow_dispatch re-cut path skips semantic-release entirely, so release_notes is the empty string in that case - the operator can follow up with the backfill-release-notes workflow to populate the body afterwards. - release-shared.yml: new optional release_notes workflow_call input, wired as the body of the softprops/action-gh-release step that creates the draft release. No generate_release_notes: true - the action appends GitHub's auto notes to any supplied body, which would duplicate content.
Coly010
approved these changes
May 20, 2026
Added new inputs to the backfill-release-notes workflow for better control: - `tag`: Required release tag for refreshing notes. - `apply`: Optional flag to update the GitHub release body. - `non_blocking`: Optional flag to allow workflow continuation on backfill failure. Updated the workflow to use `continue-on-error` based on the `non_blocking` input, improving error handling during the backfill process.
avallete
marked this pull request as ready for review
May 20, 2026 16:50
avallete
enabled auto-merge (squash)
May 20, 2026 16:51
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stage A (#prior PR) added @semantic-release/release-notes-generator to the plugin chain and a manual backfill workflow to validate the format. This change wires the same notes into the production release pipeline so future releases on develop/main come with a populated GH Release body instead of an empty page.
release.yml: capture new_release_notes from the plan job's cycjimmy/semantic-release-action step into a release_notes job output using a heredoc with a random delimiter. SR_NOTES is passed via env and emitted with printf (not echo) so attacker-influenced commit bodies / PR titles can't be interpolated as shell. The workflow_dispatch re-cut path skips semantic-release entirely, so release_notes is the empty string in that case - the operator can follow up with the backfill-release-notes workflow to populate the body afterwards.
release-shared.yml: new optional release_notes workflow_call input, wired as the body of the softprops/action-gh-release step that creates the draft release. No generate_release_notes: true - the action appends GitHub's auto notes to any supplied body, which would duplicate content.
What kind of change does this PR introduce?
Bug fix, feature, docs update, ...
What is the current behavior?
Please link any relevant issues here.
What is the new behavior?
Feel free to include screenshots if it includes visual changes.
Additional context
Add any other context or screenshots.