Documentation
README
Release
Tag and publish a new version with rich, narrative release notes.
Step 1: Pre-flight
Run in parallel:
git branch --show-current # Must be main
git status --porcelain # Must be clean
git log origin/main..HEAD --oneline # Must be empty (all pushed)
If any fail: report and stop.
Run make check — all must pass.
Step 2: Determine Version
Get the last tag:
git describe --tags --abbrev=0
Parse $ARGUMENTS:
- If a semver like
2.4.0→ use it directly - If
patch/minor/major→ bump the last tag accordingly - If empty → analyze commits since last tag to suggest:
featcommits → minor- Only
fix/docs/refactor→ patch - Breaking changes → major
- Present suggestion, ask user to confirm
This is the opening of the README. Read the full README on GitHub.