Bumping

Mon, 01 Jan 0001 00:00:00 +0000

Bumping#

Selecting a component#

There are three equivalent ways to bump, and one way to bypass component selection entirely:

bumpversion patch # shorthand for the standard components
bumpversion bump patch # explicit; works for any component
bumpversion bump pre_label # a component you defined in `parse`
bumpversion --new-version 2.0.0-rc.1 # set the version directly

major, minor, and patch exist as their own commands because they are what most projects use. Any other component — anything with a named capture group in your parse pattern — goes through bump <component>.

Inspecting

Mon, 01 Jan 0001 00:00:00 +0000

Inspecting#

Two commands report without changing anything. Both skip the dirty-tree check, so they work in a repository with uncommitted work.

`show-bump`#

Computes the next version for a component and prints it:

bumpversion show-bump patch

$ bumpversion show-bump patch
 
old_version=1.4.2
new_version=1.4.3
 
$ bumpversion show-bump minor
 
old_version=1.4.2
new_version=1.5.0
 
$ bumpversion show-bump major
 
old_version=1.4.2
new_version=2.0.0

The output is two name=value lines, which is easy to consume from a shell:

CLI reference

Mon, 01 Jan 0001 00:00:00 +0000

CLI reference#

$ bumpversion --help
 
bump git version
 
Usage: bumpversion [OPTIONS] [ARGS]... [COMMAND]
 
Commands:
 major
 minor
 patch
 show
 show-bump
 bump
 help Print this message or the help of the given subcommand(s)
 
Arguments:
 [ARGS]...
 
Options:
 --dir <DIR>
 repository directory to run bumpversion in [env: BUMPVERSION_DIR=]
 --config-file <CONFIG_FILE>
 config file to read most of the variables from [env: BUMPVERSION_CONFIG_FILE=]
 --color <COLOR_CHOICE>
 enable or disable color [env: BUMPVERSION_COLOR=]
 -v, --verbose...
 Increase logging verbosity
 -q, --quiet...
 Decrease logging verbosity
 --log <LOG_LEVEL>
 Log level. When using a more sophisticated logging setup using RUST_LOG environment variable, this option is overwritten. [env: BUMPVERSION_LOG_LEVEL=]
 --allow-dirty
 don't abort if working directory is dirty [env: BUMPVERSION_ALLOW_DIRTY=]
 --no-allow-dirty
 explicitly abort if dirty [env: BUMPVERSION_NO_ALLOW_DIRTY=]
 --current-version <CURRENT_VERSION>
 version that needs to be updated [env: BUMPVERSION_CURRENT_VERSION=]
 --new-version <NEW_VERSION>
 new version that should be in the files [env: BUMPVERSION_NEW_VERSION=]
 --parse <PARSE_VERSION_PATTERN>
 regex parsing the version string [env: BUMPVERSION_PARSE=]
 --serialize <SERIALIZE_VERSION_PATTERNS>
 how to format what is parsed back to a version [env: BUMPVERSION_SERIALIZE=]
 --search <SEARCH>
 template for complete string to search [env: BUMPVERSION_SEARCH=]
 --replace <REPLACE>
 template for complete string to replace [env: BUMPVERSION_REPLACE=]
 --regex
 treat the search parameter as a regular expression [env: BUMPVERSION_REGEX=]
 --no-regex
 explicitly do not treat the search parameter as a regular expression [env: BUMPVERSION_NO_REGEX=]
 --no-configured-files
 only replace the version in files specified on the command line, ignoring the files from the configuration file [env: BUMPVERSION_NO_CONFIGURED_FILES=]
 --ignore-missing-files
 ignore any missing files when searching and replacing in files [env: BUMPVERSION_IGNORE_MISSING_FILES=]
 --no-ignore-missing-files
 do not allow missing files when searching and replacing in files [env: BUMPVERSION_NO_IGNORE_MISSING_FILES=]
 --ignore-missing-version
 ignore any missing versions when searching and replacing in files [env: BUMPVERSION_IGNORE_MISSING_VERSION=]
 --no-ignore-missing-version
 do not allow missing versions when searching and replacing in files [env: BUMPVERSION_NO_IGNORE_MISSING_VERSION=]
 -n, --dry-run
 don't write any files, just pretend. [env: BUMPVERSION_DRY_RUN=]
 --commit
 commit to version control [env: BUMPVERSION_COMMIT=]
 --no-commit
 do not commit to version control [env: BUMPVERSION_NO_COMMIT=]
 --tag
 create a tag in version control [env: BUMPVERSION_TAG=]
 --no-tag
 do not create a tag in version control [env: BUMPVERSION_NO_TAG=]
 --sign-tags
 sign tags if created [env: BUMPVERSION_SIGN_TAGS=]
 --no-sign-tags
 do not sign tags if created [env: BUMPVERSION_NO_SIGN_TAGS=]
 --tag-name <TAG_NAME>
 tag name (only works with --tag) [env: BUMPVERSION_TAG_NAME=]
 --tag-message <TAG_MESSAGE>
 tag message [env: BUMPVERSION_TAG_MESSAGE=]
 -m, --message <COMMIT_MESSAGE>
 commit message [env: BUMPVERSION_MESSAGE=]
 --commit-args <COMMIT_ARGS>
 extra arguments to commit command [env: BUMPVERSION_COMMIT_ARGS=]
 -h, --help
 Print help
 -V, --version
 Print version

Every flag below is global: accepted at the top level and on every subcommand alike. Each also has an environment variable, named BUMPVERSION_ plus the flag in upper snake case.

Commands on bumpversion

Bumping

Bumping#

Selecting a component#

Inspecting

Inspecting#

show-bump#

CLI reference

CLI reference#

`show-bump`#