🚀 Bumper

> 🚀 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.

✨ Features

$3

- Automated Releases - One command creates tags, changelogs, and GitHub releases
- Smart Versioning - Automatic patch/minor/major version bumping
- Beautiful Changelogs - Auto-generated with emojis and smart categorization
- NPM Publishing - Seamless package publishing with authentication

$3

- Commit Validation - Enforces conventional commit standards
- Interactive Commits - Guided commit message creation
- Commit Suggestions - AI-powered commit message improvements
- Git Hooks - Pre-commit validation with Husky

$3

- Auto-Labeling - Automatically label PRs based on commit messages
- Release Readiness - Validate releases based on GitHub labels and requirements
- Enhanced Changelogs - Group changelog entries by labels for better organization
- Workflow Automation - GitHub Actions for seamless integration

$3

- Zero Configuration - Works out of the box with sensible defaults
- Beautiful UX - Colorful output with spinners and progress indicators
- Platform Agnostic - Works with any Git-based project
- Flexible Configuration - Customize everything via bumper.config.json

🚀 Quick Start

$3

Recommended: Per-Project Installation

``bash
npm install --save-dev bumper-cli
`

Alternative: Global Installation

`bash
npm install -g bumper-cli
`

$3

`bash


Initialize bumper in your project

bumper setup

or 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

$3

`bash


Preview what your release will look like

npm run changelog:preview

Create a patch release

npm run release:patch
`

🔄 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-sand

Start from a specific date

bumper line-in-sand --start-date 2024-01-01

Start from a specific commit

bumper line-in-sand --start-commit abc12345

Start 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-legacy

Analyze specific commit range

bumper analyze-legacy --range HEAD~100..HEAD

Save 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-legacy

Force migration even if already set up

bumper migrate-legacy --force

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

Format commits in a specific range

bumper bulk-format --range HEAD~50..HEAD

Apply 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