Skip to content

Commit 6893d76

Browse files
committed
docs: fix release notes template — clarify unescaped backtick usage in gh release edit heredoc
1 parent 5db27e7 commit 6893d76

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,8 @@ curl -fsSL https://openboot.dev/install | bash
164164
| macOS | Intel | `openboot-darwin-amd64` |
165165
```
166166

167+
> **Note:** The `\`\`\`` above is how triple backticks are shown inside a Markdown code block. In the actual `gh release edit` command, use real unescaped triple backticks (` ``` `).
168+
167169
**Rules:**
168170

169171
- Omit empty sections (no "Bug Fixes" if there are none)
@@ -185,13 +187,25 @@ curl -fsSL https://openboot.dev/install | bash
185187

186188
**Step 3: Update the release on GitHub**
187189

190+
Use a `'EOF'` heredoc so the shell doesn't interpret backticks — this is the only safe way to embed triple backtick code blocks:
191+
188192
```bash
189193
gh release edit v0.24.0 --repo openbootdotdev/openboot --notes "$(cat <<'EOF'
190194
## What's New
191-
- ...
195+
- **Feature name** — One sentence description (`openboot <command>`)
192196
193197
## Installation
194-
...
198+
199+
```bash
200+
curl -fsSL https://openboot.dev/install | bash
201+
```
202+
203+
## Binaries
204+
205+
| Platform | Architecture | Download |
206+
|----------|--------------|----------|
207+
| macOS | Apple Silicon (M1/M2/M3) | `openboot-darwin-arm64` |
208+
| macOS | Intel | `openboot-darwin-amd64` |
195209
EOF
196210
)"
197211
```

0 commit comments

Comments
 (0)