You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: strengthen release skill to enforce changelog in release commit
Step 4 now explicitly states changelog must be in the release commit,
not a follow-up. Step 7 includes a verification check.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: .claude/skills/release.md
+30-4Lines changed: 30 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,9 +44,33 @@ If previous releases have mismatches (e.g., GitHub release exists but no git tag
44
44
45
45
Edit the `version = "..."` line in `Cargo.toml` to the new version. Skip if already correct.
46
46
47
-
### 4. Add changelog entry to README
47
+
### 4. Add changelog entry to README (MANDATORY — must be in the release commit)
48
48
49
-
Read the changelog section in `README.md`. Add a new `### v<VERSION>` entry above the previous version with bullet points summarizing the changes. Use `git log --oneline <previous_tag>..HEAD` to see what changed.
49
+
**This step MUST happen before the commit in Step 7.** The changelog is part of the release commit, not a follow-up.
50
+
51
+
1. Find the previous release tag:
52
+
```bash
53
+
git tag -l 'v*'| sort -V | tail -1
54
+
```
55
+
56
+
2. Get all changes since the last tag:
57
+
```bash
58
+
git log --oneline <previous_tag>..HEAD
59
+
```
60
+
61
+
3. Read the `## Changelog` section in `README.md` and add a new `### v<VERSION>` entry **above** the previous version.
cd /Users/kshum/Documents/gitproj/semantic-diff && git add Cargo.toml Cargo.lock README.md && git commit -m "chore: release v<VERSION> with changelog"
85
109
```
86
110
111
+
**Verify README.md is included** — if `git diff --cached README.md` shows no changes, Step 4 was skipped. Go back and add the changelog entry before committing.
112
+
87
113
Push to main:
88
114
```bash
89
115
cd /Users/kshum/Documents/gitproj/semantic-diff && git push origin main
0 commit comments