Version Bumper

Version Bumper keeps a project’s Semantic Versioning number in sync across every place that declares it: pyproject.toml, package.json, an Xcode project, a Sphinx conf.py, CI config, among references in your own source code, documentation files, etc. It can optionally drive a release’s Git workflow (tagging, branch merges) as part of the version bumping action.

It solves the recurring pain of a version living in several files at once and going stale in some of them after a manual bump: Version Bumper refuses to write anything if the files it finds disagree, and rewrites every file in place, changing only the version string and leaving everything else about the file untouched.

Installation instructions and a minimal taste of the command line are in the project’s README. This site is the full reference.

Newcomers

• Getting started
  • Installation
  • Try it on a real project
  • How it works

Guide

• Configuration
  • Top-level keys
  • exclude vs. a discoverer’s own include
  • .vbumpignore
  • Built-in containers
• Recognizing your own file formats
  • Worked examples
  • Fields
• Projects with no version file at all
  • tag_prefix
  • Not auto-detected by vbump init
• Git workflows
  • Fields
  • Reusing a flow across projects: ~/.vbumpconfig.yaml
  • Scaffolding a new project with flows already in place

Plugin developers

• Writing a plugin
  • What a plugin contributes
  • The protocol a plugin implements
  • The shape a discoverer config class satisfies
  • Registering the entry point

Reference

• CLI reference
  • vbump
  • vbump flow add