.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH BUMPVERSION "1" "November 2021" "bumpversion 1.0.1" "User Commands"
.SH NAME
bumpversion \- Version-bump your software
.SH DESCRIPTION
usage: bumpversion [\-h] [\-\-config\-file FILE] [\-\-verbose] [\-\-list]
.IP
[\-\-allow\-dirty] [\-\-parse REGEX] [\-\-serialize FORMAT]
[\-\-search SEARCH] [\-\-replace REPLACE]
[\-\-current\-version VERSION] [\-\-no\-configured\-files]
[\-\-dry\-run] \fB\-\-new\-version\fR VERSION [\-\-commit | \fB\-\-no\-commit]\fR
[\-\-tag | \fB\-\-no\-tag]\fR [\-\-sign\-tags | \fB\-\-no\-sign\-tags]\fR
[\-\-tag\-name TAG_NAME] [\-\-tag\-message TAG_MESSAGE]
[\-\-message COMMIT_MSG] [\-\-commit\-args COMMIT_ARGS]
part [file ...]
.PP
bumpversion: v1.0.1 (using Python v3.9.7)
.SS "positional arguments:"
.TP
part
Part of the version to be bumped.
.TP
file
Files to change (default: [])
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-config\-file\fR FILE
Config file to read most of the variables from
(default: .bumpversion.cfg)
.TP
\fB\-\-verbose\fR
Print verbose logging to stderr (default: 0)
.TP
\fB\-\-list\fR
List machine readable information (default: False)
.TP
\fB\-\-allow\-dirty\fR
Don't abort if working directory is dirty (default:
False)
.TP
\fB\-\-parse\fR REGEX
Regex parsing the version string (default: (?P<major>\e
d+)\e.(?P<minor>\ed+)\e.(?P<patch>\ed+)(\e\-(?P<release>[a\-z
]+))?)
.TP
\fB\-\-serialize\fR FORMAT
How to format what is parsed back to a version
(default: ['{major}.{minor}.{patch}\-{release}',
\&'{major}.{minor}.{patch}'])
.TP
\fB\-\-search\fR SEARCH
Template for complete string to search (default:
{current_version})
.TP
\fB\-\-replace\fR REPLACE
Template for complete string to replace (default:
{new_version})
.TP
\fB\-\-current\-version\fR VERSION
Version that needs to be updated (default: 1.0.1)
.TP
\fB\-\-no\-configured\-files\fR
Only replace the version in files specified on the
command line, ignoring the files from the
configuration file. (default: False)
.TP
\fB\-\-dry\-run\fR, \fB\-n\fR
Don't write any files, just pretend. (default: False)
.TP
\fB\-\-new\-version\fR VERSION
New version that should be in the files (default:
None)
.TP
\fB\-\-commit\fR
Commit to version control (default: True)
.TP
\fB\-\-no\-commit\fR
Do not commit to version control
.TP
\fB\-\-tag\fR
Create a tag in version control (default: True)
.TP
\fB\-\-no\-tag\fR
Do not create a tag in version control
.TP
\fB\-\-sign\-tags\fR
Sign tags if created (default: False)
.TP
\fB\-\-no\-sign\-tags\fR
Do not sign tags if created
.TP
\fB\-\-tag\-name\fR TAG_NAME
Tag name (only works with \fB\-\-tag\fR) (default:
v{new_version})
.TP
\fB\-\-tag\-message\fR TAG_MESSAGE
Tag message (default: Bump version: {current_version}
??? {new_version})
.TP
\fB\-\-message\fR COMMIT_MSG, \fB\-m\fR COMMIT_MSG
Commit message (default: Bump version:
{current_version} ??? {new_version})
.TP
\fB\-\-commit\-args\fR COMMIT_ARGS
Extra arguments to commit command (default: )
.SH "SEE ALSO"
The full documentation for
.B bumpversion
is maintained as a Texinfo manual.  If the
.B info
and
.B bumpversion
programs are properly installed at your site, the command
.IP
.B info bumpversion
.PP
should give you access to the complete manual.