š A magical release management system with beautiful changelogs and automated workflows
npm install bumper-cli> š A magical release management system with beautiful changelogs and automated workflows





Bumper is a modern, developer-friendly tool that automates your entire release process. From conventional commit validation to beautiful changelog generation, automated version bumping, and seamless GitHub releases - it handles everything with style.
bumper.config.jsonRecommended: Per-Project Installation
``bash`
npm install --save-dev bumper-cli
Alternative: Global Installation
`bash`
npm install -g bumper-cli
`bash`Initialize bumper in your project
bumper setupor if installed locally:
npx bumper setup
This will:
- ā
Install necessary dependencies (@commitlint/cli, husky)
- ā
Create conventional commit validation rules
- ā
Set up Git hooks with Husky
- ā
Create GitHub Actions workflow
- ā
Add convenient NPM scripts to your package.json
- ā
Generate initial changelog
`bashPreview what your release will look like
npm run changelog:preview
š Legacy Project Migration
If you have an existing project that doesn't follow conventional commit format, bumper provides powerful tools to help you migrate. You can choose between invasive migration (rewriting history) or non-invasive migration (drawing a line in the sand).
$3
The safest approach is to draw a line in the sand and start fresh with conventional commits from a specific point forward:
`bash
Start using conventional commits from now on
bumper line-in-sandStart from a specific date
bumper line-in-sand --start-date 2024-01-01Start from a specific commit
bumper line-in-sand --start-commit abc12345Start from a specific tag
bumper line-in-sand --tag v1.0.0
`Benefits:
- ā
No git history rewriting - completely safe
- ā
Immediate setup - start using conventional commits right away
- ā
Team friendly - no coordination needed
- ā
Gradual adoption - legacy commits remain unchanged
- ā
Changelog support - works with mixed commit formats
What happens:
- Sets up conventional commit infrastructure
- Creates a marker file and git tag to track the start point
- All new commits from that point forward use conventional format
- Legacy commits remain unchanged but are still included in changelogs
- Commit validation is active for new commits only
$3
For projects that want to convert all existing commits to conventional format:
$3
`bash
Analyze commit patterns in your project
bumper analyze-legacyAnalyze specific commit range
bumper analyze-legacy --range HEAD~100..HEADSave analysis to file
bumper analyze-legacy --output analysis.json
`This will show you:
- š Commit statistics and migration rate
- š Common commit patterns and suggested types
- š” Recommended migration strategy
- šÆ Next steps for your project
$3
`bash
Migrate project to conventional commits
bumper migrate-legacyForce migration even if already set up
bumper migrate-legacy --forceMigrate commits from a specific date
bumper migrate-legacy --start-date 2024-01-01
`This will:
- ā
Install conventional commit dependencies
- ā
Set up commitlint and husky hooks
- ā
Add convenient npm scripts
- ā
Configure validation rules
$3
`bash
Preview bulk formatting
bumper bulk-format --dry-runFormat commits in a specific range
bumper bulk-format --range HEAD~50..HEADApply formatting (rewrites git history)
bumper bulk-format
`ā ļø Warning: Bulk formatting rewrites git history. Always backup your repository first!
$3
For large projects, consider a gradual approach:
1. Start with new commits using
bumper commit or bumper suggest
2. Format recent commits with bumper bulk-format --range HEAD~20..HEAD
3. Analyze progress with bumper analyze-legacy
4. Repeat until migration is complete$3
Bumper automatically suggests the best migration strategy:
- Line in the Sand: Recommended - Start fresh from a specific point (non-invasive)
- Bulk: For projects with < 50 legacy commits (invasive)
- Hybrid: For projects with mixed conventional/legacy commits (invasive)
- Gradual: For large projects with > 100 legacy commits (invasive)
$3
| Approach | Best For | Risk Level | Team Coordination |
|----------|----------|------------|-------------------|
| Line in the Sand | Most projects | š¢ None | None needed |
| Bulk | Small projects, solo developers | š” Medium | Minimal |
| Gradual | Large projects, teams | š” Medium | Moderate |
| Hybrid | Mixed commit history | š” Medium | Moderate |
š Usage Guide
$3
| Method | Install Command | Usage Command | Works In | Best For |
|--------|----------------|---------------|----------|----------|
| Per-Project |
npm install --save-dev bumper-cli | npm run