bumpcraft
v1.5.8
Published
A pluggable semantic versioning engine with changelog generation, release policies, and a web dashboard
Maintainers
Readme
Bumpcraft
Pluggable semantic versioning and changelog automation engine. Automates version bumping, changelog generation, and release management through a pipeline architecture with swappable plugins.
Features
- Automatic version bumping from Conventional Commits (
feat:,fix:,BREAKING CHANGE) - Changelog generation in Markdown or JSON (or write your own formatter)
- GitHub Releases integration
- Release preview dashboard — web UI showing pending changes and next version
- Release groups — batch commits into named releases
- Interactive mode — review and edit changelog before releasing
- Release policies — approval gates, freeze windows, rate limits
- Queryable history — search past releases by scope, type, breaking changes
- Pluggable everything — parsers, formatters, release providers are all swappable
Quick Start
# Install
npm install bumpcraft
# Initialize config
npx bumpcraft init
# Preview what a release would do
npx bumpcraft validate
# Release
npx bumpcraft releaseDocumentation
- Installation Guide
- CLI Reference
- Configuration
- REST API
- Plugin Development
- Library API
- Release Groups
- Release Policies
- History & Querying
- Dashboard
- Monorepo Support
- Publishing
- Changeset Files
- Version PR Mode
- Lifecycle Hooks
- Docker Deployment
- Deployment Guide
- Architecture
How It Works
You write commits using Conventional Commits:
feat(auth): add OAuth2 support fix(api): handle null response feat!: redesign user API # breaking changeRun
bumpcraft release. The pipeline:- Parses commits since the last tag
- Resolves the bump type (
major>minor>patch) - Generates a changelog
- Creates a git tag and GitHub release
- Records the release in queryable history
Done. Version bumped, changelog written, release published.
License
MIT
