feat(cutting-releases): add release highlights step#3382
Conversation
After post-flight verification, the skill now researches merged PRs via a sub-agent and drafts user-facing prose highlights that get prepended to the GitHub release body above the auto-generated changelog. Assisted-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Ralph Bean <rbean@redhat.com>
|
🤖 Finished Review · ❌ Failure · Started 4:25 PM UTC · Completed 4:30 PM UTC |
PR Summary by QodoAdd a release-highlights step to cutting-releases skill
AI Description
Diagram
High-Level Assessment
Files changed (1)
|
Site previewPreview: https://fc6c653a-site.fullsend-ai.workers.dev Commit: |
Code Review by Qodo
1. Indented heredoc terminator
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
| ``` | ||
| gh release edit <tag> --notes "$(cat <<'EOF' | ||
| <highlights> | ||
| --- | ||
| <existing body> | ||
| EOF | ||
| )" |
There was a problem hiding this comment.
1. Indented heredoc terminator 🐞 Bug ≡ Correctness
The Step 9 example for gh release edit indents the heredoc terminator (EOF) inside a list-indented fenced block, so a literal copy/paste will not terminate the heredoc and will wait for more input. This can block the new “prepend highlights” step at the final release-update command.
Agent Prompt
### Issue description
The Step 9 snippet uses a heredoc within a list-indented fenced code block. In the markdown source, every line (including the `EOF` terminator) is indented, which makes the heredoc terminator not match when the command is run as written, causing the shell to keep waiting for input.
### Issue Context
This is user-facing operational guidance intended to be run during the release process; the example should be safe to copy/paste and execute.
### Fix Focus Areas
- skills/cutting-releases/SKILL.md[150-159]
### Suggested fix approaches
Choose one:
1. Move the fenced code block out of the nested list so `EOF` can be flush-left.
2. Avoid heredocs here and use a temp file + `gh release edit ... --notes-file <path>` (or an equivalent approach already used in this repo).
3. If you must keep it nested, rewrite the snippet so the terminator is guaranteed to be at column 0 in the rendered/output command (not indented in the literal text).
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Review — commentPR: #3382 — SummaryThis PR inserts a new step 9 ("Write release highlights") into the cutting-releases skill, renumbering the previous step 9 ("Install the binary locally") to step 10. The new step instructs the agent to:
The change is well-structured, follows the existing skill conventions, and the human-in-the-loop confirmation before mutating the release is a good design choice. Findings1.
|
deboer-tim
left a comment
deboer-tim
left a comment
There was a problem hiding this comment.
Will need to see how it works on the next release, and assess the format/content it produces over time, but LGTM and matches what we discussed on calls. 👍🏼
waynesun09
left a comment
waynesun09
left a comment
There was a problem hiding this comment.
LGTM — nice addition. One thing to fix before merge:
Step 9.2 instructs the executor to launch an Agent sub-agent, but Agent is not in the allowed-tools frontmatter. Since this skill explicitly restricts its tool set, the Agent call will trigger a permission prompt at runtime. Add Agent to the allowed-tools list to keep the flow automated.
|
🤖 Finished Retro · ✅ Success · Started 6:36 PM UTC · Completed 6:45 PM UTC |
|
PR #3382 added a release-highlights step to the cutting-releases skill. Both the review agent and human reviewer waynesun09 correctly identified that the Proposals filed
|
3 participants
Summary
---separatorTest plan
gh release edit🤖 Generated with Claude Code