@topdaily-dev/shipkit
v0.1.0
Published
Ship OSS releases safely — preflight checks, changelog, GitHub release, and npm publish in one command
Maintainers
Readme
Why shipkit?
Releasing should not be a checklist you keep in your head.
shipkit automates the boring, error-prone release flow for small OSS projects:
- Preflight checks (git status, tests, tooling)
- Conventional-commit changelog generation
- Version bump +
CHANGELOG.mdupdate - Git tag + GitHub release via
gh - npm publish with dry-run by default
Plain files. No SaaS. You own everything.
Quick start
npx @topdaily-dev/shipkit preflight
npx @topdaily-dev/shipkit release --minor --dry-run
npx @topdaily-dev/shipkit release --patch
npx @topdaily-dev/shipkit publish --yesOr do it all at once:
npx @topdaily-dev/shipkit ship --minor --yesCommands
| Command | What it does |
|---------|----------------|
| preflight | Check git, tests, and tooling before a release |
| changelog | Preview release notes from commits since last tag |
| release | Bump version, update CHANGELOG, tag, and create GitHub release |
| publish | npm publish (dry-run unless --yes) |
| ship | release + optional publish --yes |
Examples
Preview the next release without changing anything:
shipkit release --minor --dry-runAllow a dirty working tree (not recommended for production releases):
shipkit release --patch --allow-dirtySkip tests during preflight:
shipkit release --patch --skip-testsPair with collab-kit
npx @korykaai/collab-kit init .
# ... build your project ...
npx @topdaily-dev/shipkit ship --minor --yesRequirements
- Node.js 20+
- git
- GitHub CLI (
gh) forreleaseandship - npm account for
publish
Development
git clone https://github.com/topdaily-dev/shipkit.git
cd shipkit
npm test
node bin/shipkit.mjs --helpSee CONTRIBUTING.md.
License
MIT — see LICENSE.
