Skip to content

Commit 1e99faf

Browse files
docs: Add release script instructions to CLAUDE.md (#1202)
## Summary - Adds `hatch run scripts:update-version` to Quick Reference - Adds a Releasing section explaining the script's workflow and options 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7d090c0 commit 1e99faf

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,23 @@ hatch run lint:fmt
1717
# Generate models from schemas
1818
hatch run scripts:generate-schemas \
1919
"http://purl.allotrope.org/json-schemas/adm/cell-counting/REC/2024/09/cell-counting.schema"
20+
21+
# Release a new version (bumps patch, updates CHANGELOG, creates branch/tag/PR/release)
22+
hatch run scripts:update-version
2023
```
2124

25+
## Releasing
26+
27+
Use `hatch run scripts:update-version` to create a new release. Do NOT use `hatch version` directly. The script:
28+
1. Checks out a clean branch from main (`release-v{version}`)
29+
2. Bumps the patch version in `__about__.py`
30+
3. Updates `CHANGELOG.md` from conventional commit prefixes since last release
31+
4. Commits, pushes, tags, creates a PR and GitHub release
32+
33+
Options:
34+
- `--version/-v X.Y.Z` — set an explicit version instead of auto-incrementing patch
35+
- `--skip_pr` — only update files locally without pushing/creating PR
36+
2237
## Architecture Overview
2338

2439
```

0 commit comments

Comments
 (0)