bumpversion(1)

Version-bump your software

Section 1 bumpversion bookworm source

Description

BUMPVERSION

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		Part of the version to be bumped.
	file		Files to change (default: [])

optional arguments:

-h, --help

show this help message and exit

--config-file FILE

Config file to read most of the variables from (default: .bumpversion.cfg)

--verbose

Print verbose logging to stderr (default: 0)

--list

List machine readable information (default: False)

--allow-dirty

Don’t abort if working directory is dirty (default: False)

--parse REGEX

Regex parsing the version string (default: (?P<major>\ d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z ]+))?)

--serialize FORMAT

How to format what is parsed back to a version (default: [’{major}.{minor}.{patch}-{release}’, ’{major}.{minor}.{patch}’])

--search SEARCH

Template for complete string to search (default: {current_version})

--replace REPLACE

Template for complete string to replace (default: {new_version})

--current-version VERSION

Version that needs to be updated (default: 1.0.1)

--no-configured-files

Only replace the version in files specified on the command line, ignoring the files from the configuration file. (default: False)

--dry-run, -n

Don’t write any files, just pretend. (default: False)

--new-version VERSION

New version that should be in the files (default: None)

--commit

Commit to version control (default: True)

--no-commit

Do not commit to version control

--tag

Create a tag in version control (default: True)

--no-tag

Do not create a tag in version control

--sign-tags

Sign tags if created (default: False)

--no-sign-tags

Do not sign tags if created

--tag-name TAG_NAME

Tag name (only works with --tag) (default: v{new_version})

--tag-message TAG_MESSAGE

Tag message (default: Bump version: {current_version} ??? {new_version})

--message COMMIT_MSG, -m COMMIT_MSG

Commit message (default: Bump version: {current_version} ??? {new_version})

--commit-args COMMIT_ARGS

Extra arguments to commit command (default: )