tomevault-io Do Release
Release a new version — bump, changelog, build, test, tag, publish, GitHub Release.
Workflow
Step 1: Pre-Flight
Verify the repo is ready for release:
| Check | Required | Action if failed |
|---|---|---|
On main or release branch |
Yes | Switch to main: git checkout main && git pull |
| Clean working tree | Yes | Commit or stash changes (consider commit first) |
| All tests pass | Yes | Run full test suite, fix failures |
| Up-to-date with remote | Yes | git pull origin main |
Step 2: Version Bump
Determine the version increment from the argument (patch, minor, major). If no argument, analyze commits since last tag to suggest:
| Commit pattern | Suggested bump |
|---|---|
fix: only |
patch |
feat: present |
minor |
BREAKING CHANGE: or !: |
major |
Bump version in all relevant files based on detected languages:
| Language | File(s) to update |
|---|---|
| TypeScript | package.json (and workspace package.json files) |
| Python | pyproject.toml ([project] version) |
| Rust | Cargo.toml ([package] version) |
For monorepos with multiple packages, bump each changed package.
Step 3: Changelog Finalize
Update CHANGELOG.md:
- Move entries under
## [Unreleased]to a new version heading:## [X.Y.Z] - YYYY-MM-DD - Add a fresh empty
## [Unreleased]section at the top - Verify entries reflect actual changes (cross-reference with commits)
- Reference
docs-managerskill for changelog format conventions
Step 4: Build
Run a clean build to verify everything compiles with the new version:
| Language | Command |
|---|---|
| TypeScript | pnpm build or npm run build |
| Python | hatch build or python -m build |
| Rust | cargo build --release |
Step 5: Final Test
Run the full test suite one more time after version bump and build:
| Language | Command |
|---|---|
| TypeScript | pnpm test |
| Python | pytest |
| Rust | cargo test |
Step 6: Commit + Tag
git add -A
git commit -m "chore: release vX.Y.Z"
git tag -a vX.Y.Z -m "Release vX.Y.Z"
Step 7: Publish
Publish to registries based on detected languages:
| Language | Command | Notes |
|---|---|---|
| TypeScript | npm publish or pnpm publish |
Ensure publishConfig is set correctly |
| Python | hatch publish or twine upload dist/* |
Requires PyPI credentials |
| Rust | cargo publish |
Requires crates.io token |
For monorepos, publish each changed package individually.
Important: Verify authentication is configured before publishing. Check for:
- npm:
npm whoami - PyPI:
~/.pypircorTWINE_USERNAME/TWINE_PASSWORD - crates.io:
cargo loginstatus
Step 8: Push + GitHub Release
git push origin main --tags
Create a GitHub Release:
gh release create vX.Y.Z --title "vX.Y.Z" --notes-file <changelog-excerpt>
Extract the changelog section for this version as the release notes.
Step 9: Post-Release
- Print summary: version published, registries updated, release URL
- Remind about announcements (if applicable)
- Verify the package is available:
npm info <pkg>/pip install <pkg>==X.Y.Z --dry-run
Reference
See release-checklist.md for the expanded checklist.
Source: lushly-dev/botcore — distributed by TomeVault.