The bumpr.rc configuration file is an inifile with the following possible sections and keys.
This is the main section defining the common behavior and parameters.
Default: None
The file containing the version string to extract.
Default: r'(__version__|VERSION)\s*=\s*(\'|")(?P<version>.+?)(\'|")'
The regex used to extract the version string. It must have a version named group.
Default: utf8
The files encoding.
Default: True
If True and vcs is defined, commit the changes.
Default: True
If True and vcs is defined, tag the version.
Default: False
If True, display verbose output and command line output.
Default: False
TODO
Default: None
Specify the commands to be executed on the clean phase. Should have a single command by line.
Default: None
Specify the commands to be executed on the test phase. Should have a single command by line.
Default: None
Specify the commands to be executed on the publish phase. Should have a single command by line.
Default: []
Extra files to process. Those files will be processed by hooks to. Specify one file by line.
This section define the bump phase behavior.
Default: True
If True the current verion suffix will be removed.
Default: None
If set, this suffix will ba appended to the version.
Default: None
Specify the part to bump between major, minor or patch.
Default: Bump version {version}
Specify the commit message that will be bumped. You can use the following token in your format pattern: version, major, minor, patch and date. All formating operations are accepted.
This section define the prepare phase behavior.
Default: False
If True the current verion suffix will be removed.
Default: None
If set, this suffix will ba appended to the version.
Default: patch
Specify the part to bump between major, minor or patch.
Default: Update to version {version} for next development cycle
Specify the commit message that will be bumped. You can use the following token in your format pattern: version, major, minor, patch and date. All formating operations are accepted.
Here a sample bumpr.rc file
[bumpr]
file = fake/__init__.py
vcs = git
tests = tox
publish = python setup.py register sdist upload
clean =
python setup.py clean
rm -rf *egg-info build dist
files = README.rst
[bump]
message = 'Commit version {version}'
[prepare]
suffix = dev
message = Prepare version {version} for next development cycle
[changelog]
file = CHANGELOG.rst
bump = {version} ({date:%Y-%m-%d})
prepare = In development
[readthedoc]
id = bumpr