Skip to content

Commit 4e30f83

Browse files
committed
docs: document GitHub release process in CLAUDE.md
Add a "GitHub Release" section after "Version Bumping" with the gh release create command template, a release-body checklist (changelog verbatim + impact note + migration note + full changelog link), and naming conventions.
1 parent f36d109 commit 4e30f83

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,50 @@ When committing a set of changes, bump the version using semver:
123123
Two files must always be updated together:
124124
- `pyproject.toml``version = "x.y.z"`
125125
- `quantumvalidator/__init__.py` → fallback `__version__ = "x.y.z"` (the `except` branch)
126+
127+
## GitHub Release
128+
129+
Every version bump **must** be followed by a GitHub release. Do not leave a version tag without a release.
130+
131+
**After bumping the version, committing, and pushing:**
132+
133+
```bash
134+
# Tag the version commit and push
135+
git tag vX.Y.Z
136+
git push origin vX.Y.Z
137+
138+
# Create the GitHub release
139+
gh release create vX.Y.Z \
140+
--title "vX.Y.Z" \
141+
--notes "$(cat <<'EOF'
142+
## What's changed
143+
144+
<Copy the ### Added / ### Changed / ### Fixed / ### Removed blocks verbatim
145+
from the [X.Y.Z] section in CHANGELOG.md>
146+
147+
## Impact
148+
149+
<1–3 sentences: what this means for users — what improves, what breaks,
150+
whether the upgrade is urgent (e.g. new PQC group support, probe fix, etc.)>
151+
152+
## Migration
153+
154+
<Only for minor/major bumps: list any CLI flags, `assess()` parameters, or
155+
output-format changes that require user action. Omit for patch releases.>
156+
157+
---
158+
159+
**Full changelog:** https://github.com/NC3-TestingPlatform/quantumvalidator/blob/master/CHANGELOG.md
160+
EOF
161+
)"
162+
```
163+
164+
**Release body checklist:**
165+
- [ ] Changelog entries for this version copied verbatim
166+
- [ ] Impact note written (even one sentence is enough)
167+
- [ ] Migration note present if CLI flags or `assess()` signature changed
168+
- [ ] Full changelog link at the bottom
169+
170+
**Conventions:**
171+
- Tag and title: `vX.Y.Z` — semver, `v`-prefixed, must match `pyproject.toml` version
172+
- Do not mark as draft or pre-release for normal semver releases

0 commit comments

Comments
 (0)