Skip to content

Commit 373055c

Browse files
reid-spencerclaude
andcommitted
Update /ship skill to require detailed release notes
Replace --generate-notes with instructions to analyze commits and write human-readable, structured release notes for this public repository. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 2d394d9 commit 373055c

1 file changed

Lines changed: 40 additions & 2 deletions

File tree

.claude/skills/ship/SKILL.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,48 @@ not provided:
8989
git push origin main <VERSION>
9090
```
9191
92-
11. Create a GitHub release:
92+
11. **Write detailed release notes** and create the GitHub
93+
release. Do NOT use `--generate-notes` — the auto-generated
94+
notes are just commit titles and are not suitable for a
95+
public repository.
96+
97+
Instead, read all commits since the previous tag:
98+
```
99+
git log --format="%H %s" <PREV_TAG>..<VERSION>
100+
```
101+
Then read the diffs for any non-trivial commits to
102+
understand what actually changed. Write human-readable
103+
release notes in this format:
104+
105+
```markdown
106+
## What's New
107+
108+
### Features
109+
- **Feature name** — Clear description of what was added
110+
and why it matters to users.
111+
112+
### Bug Fixes
113+
- **Area affected** — What was broken and how it's fixed.
114+
115+
### Improvements
116+
- **Area affected** — What changed and why it's better.
117+
118+
### Internal
119+
- Dependency upgrades, CI fixes, documentation updates,
120+
and other changes that don't affect end users directly.
121+
```
122+
123+
Omit any section that has no entries. Focus on what users
124+
and consumers of the library need to know. Use clear,
125+
complete sentences — not just commit message echo.
126+
127+
Create the release:
93128
```
94129
unset GITHUB_TOKEN && gh release create <VERSION> \
95-
--title "Release <VERSION>" --generate-notes
130+
--title "Release <VERSION>" --notes "$(cat <<'EOF'
131+
<release notes here>
132+
EOF
133+
)"
96134
```
97135
This triggers the Release Artifacts workflow (native
98136
builds, Homebrew formula update) and the npm-publish

0 commit comments

Comments
 (0)