Scroll to navigation

BUMPVERSION(1) User Commands BUMPVERSION(1)

NAME

bumpversion - Version-bump your software

DESCRIPTION

usage: bumpversion [-h] [--config-file FILE] [--verbose] [--list]

[--allow-dirty] [--parse REGEX] [--serialize FORMAT] [--search SEARCH] [--replace REPLACE] [--current-version VERSION] [--no-configured-files] [--dry-run] --new-version VERSION [--commit | --no-commit] [--tag | --no-tag] [--sign-tags | --no-sign-tags] [--tag-name TAG_NAME] [--tag-message TAG_MESSAGE] [--message COMMIT_MSG] [--commit-args COMMIT_ARGS] part [file ...]

bumpversion: v1.0.1 (using Python v3.9.7)

positional arguments:

Part of the version to be bumped.
Files to change (default: [])

optional arguments:

show this help message and exit
Config file to read most of the variables from (default: .bumpversion.cfg)
Print verbose logging to stderr (default: 0)
List machine readable information (default: False)
Don't abort if working directory is dirty (default: False)
Regex parsing the version string (default: (?P<major>\ d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z ]+))?)
How to format what is parsed back to a version (default: ['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'])
Template for complete string to search (default: {current_version})
Template for complete string to replace (default: {new_version})
Version that needs to be updated (default: 1.0.1)
Only replace the version in files specified on the command line, ignoring the files from the configuration file. (default: False)
Don't write any files, just pretend. (default: False)
New version that should be in the files (default: None)
Commit to version control (default: True)
Do not commit to version control
Create a tag in version control (default: True)
Do not create a tag in version control
Sign tags if created (default: False)
Do not sign tags if created
Tag name (only works with --tag) (default: v{new_version})
Tag message (default: Bump version: {current_version} ??? {new_version})
Commit message (default: Bump version: {current_version} ??? {new_version})
Extra arguments to commit command (default: )

SEE ALSO

The full documentation for bumpversion is maintained as a Texinfo manual. If the info and bumpversion programs are properly installed at your site, the command

info bumpversion

should give you access to the complete manual.

November 2021 bumpversion 1.0.1