Release Process

Release Process

Step-by-step process for publishing a new version of aspens.

1. Make sure tests pass

cd aspens
npm test

2. Run CodeRabbit review

cr review --plain

Fix any findings before proceeding.

3. Bump version in package.json

Pick the right bump:

• patch (0.2.0 → 0.2.1) — bug fixes, small improvements
• minor (0.2.0 → 0.3.0) — new features
• major (0.2.0 → 1.0.0) — breaking changes

Edit package.json version field directly, or:

npm version patch --no-git-tag-version
npm version minor --no-git-tag-version
npm version major --no-git-tag-version

4. Commit and push

git add -A
git commit -m "v0.2.1: description of changes"
git push origin your-branch

5. Create PR (if on a branch)

gh pr create --base main --title "v0.2.1: description" --body "## Summary
- change 1
- change 2

## Test plan
- [x] npm test passes
- [x] tested on a real repo
"

6. After PR merges — tag and release

git checkout main
git pull
git tag v0.2.1
git push origin v0.2.1

Create GitHub release:

gh release create v0.2.1 --title "v0.2.1" --generate-notes

Or with custom notes:

gh release create v0.2.1 --title "v0.2.1" --notes "- Fixed CLAUDE.md retry logic
- Added vendored code exclusion
- Subdirectory tsconfig resolution"

7. Publish to npm

npm publish

If not logged in:

npm login
npm whoami    # verify
npm publish

8. Verify

npm view aspens
npx aspens@latest --help

9. Update docs

Check these for anything affected by the release:

• README.md — commands table, options tables, examples
• Wiki pages — Architecture, Common Recipes, Roadmap, How Aspens Works
• CLAUDE.md — quick reference, architecture section

cd /tmp && git clone https://github.com/aspenkit/aspens.wiki.git
# edit pages...
cd /tmp/aspens.wiki && git add -A && git commit -m "docs: update wiki for vX.Y.Z" && git push

CodeRabbit commands

Run a review on uncommitted changes:

cr review --plain

In PR comments on GitHub:

• @coderabbitai review — request a re-review
• @coderabbitai resolve — mark a suggestion as resolved
• @coderabbitai summary — regenerate the summary

Quick reference

# Full release flow (after PR merges)
git checkout main && git pull
git tag v0.2.1 && git push origin v0.2.1
gh release create v0.2.1 --title "v0.2.1" --generate-notes
npm publish