fix(release): strip self-referential update-cagent-action entry from release notes#211
Open
derekmisler wants to merge 2 commits into
Open
fix(release): strip self-referential update-cagent-action entry from release notes#211derekmisler wants to merge 2 commits into
derekmisler wants to merge 2 commits into
Conversation
…release notes
After each release the update-self-refs job opens a PR titled
'chore: update cagent-action to vX.Y.Z'. When the *next* release is
created with --generate-notes, this PR is included as the first bullet
in the changelog, confusing readers who expect only user-visible changes.
Add a 'Filter release notes' step immediately after 'Create GitHub
Release'. It fetches the generated body, removes any line containing
'update cagent-action to v' (the self-referential auto-update bullet),
and writes the cleaned body back via 'gh release edit --notes-file'.
The notify job fetches release notes from the GitHub API so it will
automatically receive the already-filtered body with no further changes.
Docker Agent version bumps ('update Docker Agent to v*') are
intentionally preserved — they are genuinely useful to readers.
Contributor
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
Contributor
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
Two high-severity bugs were found in the new Filter release notes step.
| Severity | Finding |
|---|---|
| 🔴 HIGH | grep -v exits code 1 when all lines filtered → step aborts under errexit |
| 🔴 HIGH | Missing emptiness guard → empty $FILTERED silently blanks release notes |
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Problem
Every GitHub release includes a bullet like:
as the first entry. This is the self-referential auto-update PR produced by the
update-self-refsjob from the previous release cycle. It is noise for readers who expect only user-visible changes.Solution
Add a
Filter release notesstep in thereleasejob, immediately afterCreate GitHub Release. It:update cagent-action to v(the self-referential bullet).gh release edit --notes-file.Because the
notifyjob fetches release notes from the GitHub API (gh release view … --json body), it automatically receives the already-filtered body — no changes needed there.What is preserved
Docker Agent version-bump entries (
update Docker Agent to v*) are intentionally kept — they are genuinely useful to readers.Why this approach
.github/release.yml+ label on the update-self-refs PR).gh release editon past releases.