Skip to content

docs: Add release script instructions to CLAUDE.md #1202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathan-stender merged 2 commits into from
May 19, 2026
Merged

docs: Add release script instructions to CLAUDE.md #1202

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
115596e
docs: Add release script instructions to CLAUDE.md
nathan-stender May 18, 2026
bd3508d
Merge branch 'main' into docs/claude-md-release-instructions
nathan-stender May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,23 @@ hatch run lint:fmt
# Generate models from schemas
hatch run scripts:generate-schemas \
"http://purl.allotrope.org/json-schemas/adm/cell-counting/REC/2024/09/cell-counting.schema"

# Release a new version (bumps patch, updates CHANGELOG, creates branch/tag/PR/release)
hatch run scripts:update-version
```

## Releasing

Use `hatch run scripts:update-version` to create a new release. Do NOT use `hatch version` directly. The script:
1. Checks out a clean branch from main (`release-v{version}`)
2. Bumps the patch version in `__about__.py`
3. Updates `CHANGELOG.md` from conventional commit prefixes since last release
4. Commits, pushes, tags, creates a PR and GitHub release

Options:
- `--version/-v X.Y.Z` — set an explicit version instead of auto-incrementing patch
- `--skip_pr` — only update files locally without pushing/creating PR

## Architecture Overview

```
Expand Down
Loading