Skip to content

Fix heredoc terminator in create-release skill - #15

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

Fix heredoc terminator in create-release skill#15
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
    • Reformatted the release creation instructions and release notes template for improved readability.
    • Preserved the existing release title, “What’s new,” and “Install” sections and commands.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6dcbb435-b5f2-4b20-9806-7e09b7008308

📥 Commits

Reviewing files that changed from the base of the PR and between 073d7ba and 5e36908.

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

📝 Walkthrough

Walkthrough

The release skill documentation reformats the Step 5 gh release create example and its heredoc release-notes template while preserving the existing command structure, sections, and placeholders.

Changes

Release Documentation

Layer / File(s) Summary
Release command example
.claude/skills/create-release/SKILL.md
Reformats the gh release create bash snippet and heredoc whitespace while retaining the title, “What’s new”, and “Install” sections.

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

✨ 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.

@GordonBeeming
GordonBeeming requested a review from Copilot July 20, 2026 07:55

@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 skill documentation (SKILL.md) to fix nested markdown code block formatting by using quadruple backticks and removing unnecessary indentation. The review feedback suggests a valuable improvement to the gh release create command, recommending the use of --notes-file - with a standard heredoc instead of a subshell with cat to simplify the syntax and avoid spawning an extra process.

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 updates the create-release skill documentation so the gh release create ... --notes "$(cat <<'EOF' ... EOF)" heredoc is copy/paste-safe by ensuring the EOF terminator is at column 0 and by using an outer four-backtick fence to safely include a nested ```bash block.

Changes:

  • Dedented the gh release create example so the heredoc terminator (EOF) is unindented and closes correctly in bash.
  • Switched the outer code fence to ````bash to avoid prematurely closing due to the nested ```bash install snippet.
  • Normalized the release-notes body indentation to match the now-unindented heredoc content.

💡 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 d99cc85 into main Jul 20, 2026
4 checks passed
@GordonBeeming
GordonBeeming deleted the gb/fix-heredoc-terminator branch July 20, 2026 08:03
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