Skip to content

Commit dd64786

Browse files
jqnatividadclaude
andcommitted
docs: improve release-prep skill step 9 clarity
- Replace `"{version}"` brace placeholder in VERSION assignment with a concrete example (`"0.9.0"`) to prevent literal expansion if the implementor forgets to substitute - Add temp-file cleanup reminder for the --notes-file path - Clarify --notes-file parenthetical to mention deletion Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 6a2d36b commit dd64786

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

.claude/skills/release-prep/SKILL.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,12 @@ Prepare a new csv-nose release. Takes an optional version number argument.
2727
- Tag: `v{version}`
2828
- Title: `v{version}`
2929
- Use `--draft` so the user can review before publishing
30-
- Pass the CHANGELOG.md entry for this version as release notes using `--notes-file` (write the entry to a temp file) or inline via `--notes`. For the inline approach, substitute the actual version number for `{version}` (e.g. `0.9.0`) in the shell variable and awk pattern:
30+
- Pass the CHANGELOG.md entry for this version as release notes using `--notes-file` (write the entry to a temp file and delete it afterwards) or inline via `--notes`. For the inline approach, set `VERSION` to the actual version number (e.g. `0.9.0`) before running:
3131
```bash
32-
VERSION="{version}" # replace with actual version, e.g. 0.9.0
32+
VERSION="0.9.0" # replace this with the actual version
3333
--notes "$(awk "/## v$VERSION/{f=1; print; next} f && /## v[0-9]/{exit} f" CHANGELOG.md)"
3434
```
35+
If using `--notes-file`, remember to delete the temp file after the `gh release create` command completes.
3536
Do NOT use `--generate-notes` (that pulls from PR history, not CHANGELOG).
3637
- Before running `gh release create`, ensure the tag exists and is pushed. Create an annotated tag if it doesn't exist locally, then push it:
3738
```

0 commit comments

Comments
 (0)