Bumpwright

Bumpwright checks your project’s public API to suggest the correct semantic version bump. It compares your code to a baseline and reports whether the next release should be a patch, minor, or major update.

Why

• Avoid missed breaking changes when commit messages fall short.

• Automate version numbers and changelog generation.

How

• Compare the current commit to a recorded baseline.

• Optional analysers inspect CLIs, web routes, migrations, and more.

Pros

• Accurate bump suggestions based on the public API.

• Flexible configuration and pluggable analysers.

• Generates release notes for you.

Cons

• Requires a Git baseline commit.

• Static analysis can’t cover runtime behaviour.

• Python 3.11+ only.

New to Bumpwright? Start with the Quickstart.

Quickstart

• Quickstart

CLI Reference

• CLI Reference

Versioning Concepts

• Versioning

Changelog & Templates

• Changelog & Templates

Recipes / How-To Guides

• Recipes & How-To Guides
  • Recipes
  • Baseline
  • CI/CD
  • Version management
  • Real-world example: Semantic release with GitHub Actions

FAQ / Troubleshooting

• FAQ & Troubleshooting

Contributing & Roadmap

• Contributing
• Roadmap