Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Latest commit

 

History

16 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CI npm version License: MIT Node

shipkit

Ship OSS releases safely — preflight, changelog, GitHub release, and npm publish.

collab-kit scaffolds your repo on day 1. repomark scores repo health. badgekit generates README badges. shipkit ships releases on day 30.


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.md update
  • 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 --yes

Or do it all at once:

npx @topdaily-dev/shipkit ship --minor --yes

Commands

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-run

Allow a dirty working tree (not recommended for production releases):

shipkit release --patch --allow-dirty

Skip tests during preflight:

shipkit release --patch --skip-tests

Pair with collab-kit

npx @korykaai/collab-kit init . --oss-toolchain
collab-kit enable-hooks .
# ... build your project ...
npx @topdaily-dev/shipkit ship --minor --yes

See collab-kit oss-toolchain.

Requirements

  • Node.js 20+
  • git
  • GitHub CLI (gh) for release and ship
  • npm account for publish

Development

git clone https://github.com/topdaily-dev/shipkit.git
cd shipkit
npm test
node bin/shipkit.mjs --help

See CONTRIBUTING.md.

License

MIT — see LICENSE.

About

Ship OSS releases safely — preflight, changelog, GitHub release, and npm publish

Topics

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages