Skip to content

Fix heredoc terminator in create-release skill#19

Merged
GordonBeeming merged 1 commit into
mainfrom
gb/fix-heredoc-terminator
Jul 20, 2026
Merged

Fix heredoc terminator in create-release skill#19
GordonBeeming merged 1 commit into
mainfrom
gb/fix-heredoc-terminator

Conversation

@GordonBeeming

@GordonBeeming GordonBeeming commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Summary

The gh release create block in .claude/skills/create-release/SKILL.md was indented under the numbered list, which put the closing EOF (and the whole --notes "$(cat <<'EOF' … EOF)" body) at a non-zero column. Bash only treats a <<'EOF' heredoc as closed when the terminator line has no leading whitespace, so a literal copy-paste of that command wouldn't close the heredoc — it would swallow the EOF line and corrupt the release notes.

Fixed by dedenting the release block to column 0 and switching the outer fence to four backticks (so the nested ```bash install block doesn't close it early), matching the already-correct ide and PullUp create-release skills. Terminator now sits at column 0.

Test plan

  • Docs-only — no code or config changes.
  • grep -n '^EOF$' confirms the terminator is at column 0.

Summary by CodeRabbit

  • Documentation
    • Updated release creation instructions with a clearer release notes template.
    • Added structured “What’s New” and “Install” sections to the template.
    • Improved formatting for generated release notes and code examples.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8ac4e57d-4cf5-4f3b-9350-993b43de795e

📥 Commits

Reviewing files that changed from the base of the PR and between a3290e0 and 72d8488.

📒 Files selected for processing (1)
  • .claude/skills/create-release/SKILL.md

📝 Walkthrough

Walkthrough

Changes

Release notes template

Layer / File(s) Summary
Reformat release notes heredoc
.claude/skills/create-release/SKILL.md
The release command’s notes template now uses a quoted heredoc with explicit newline structure and fenced “What’s New” and “Install” sections.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the main change: fixing the create-release heredoc in the skill docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch gb/fix-heredoc-terminator

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the release creation instructions in SKILL.md by using quadruple backticks to properly nest a triple-backtick code block and unindenting the bash commands. The reviewer suggested an improvement to use the native --notes-file - option of the GitHub CLI to pass multiline release notes, which is cleaner and avoids nesting command substitutions.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread .claude/skills/create-release/SKILL.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes a documentation issue in the create-release skill where a Bash heredoc terminator (EOF) could be indented when copy-pasted, preventing the heredoc from closing correctly and corrupting the gh release create --notes content.

Changes:

  • Dedented the gh release create ... --notes "$(cat <<'EOF' ... EOF)" block so the EOF terminator is at column 0 for correct heredoc closure when copy-pasted.
  • Switched the outer fenced block to four backticks to safely include a nested triple-backtick bash block inside the release notes template.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@GordonBeeming
GordonBeeming marked this pull request as ready for review July 20, 2026 08:02
@GordonBeeming
GordonBeeming merged commit 69372ea into main Jul 20, 2026
4 checks passed
@GordonBeeming
GordonBeeming deleted the gb/fix-heredoc-terminator branch July 20, 2026 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants