Package: advbumpversion
==============ADVbumpversion==============This Fork=========This is a fork (**ADVbumpversion**) of a fork (**bump2version**).The excellent original project that can be found here: https://github.com/peritus/bumpversion.Unfortunately it seems like development has been stuck for some time and no activity has been seen from theauthor.Christian Verkerk has made some Pull Request merges and this project (renamed **bump2version**) can be found here: https://github.com/c4urself/bump2version.I have merged other Push Requests, in particular the ability to have more than one rule for a file,in a new project **ADVbumpversion**. The major differences are:- It is possible to have more than one set of rules (``parse``, ``serialize``, ``search`` and ``replace``) for thesame file- Some parts of the version can be independent of the others: They are not incremented with the other parts. It is inparticular useful when you have a build number that is incremented independently of the version- Several examples of usage- More testing casesLook at ``CHANGELOG.rst`` to see all the changes.**Note**: For compatibility, this project declares ``advbumpversion``, ``bump2version`` and ``bumpversion``. They areidentical. The remaining of this document uses ``bumpversion`` in command-line examples.Introduction============Version-bump your software with a single command!A small command line tool to simplify releasing software by updating allversion strings in your source code by the correct increment. Also createscommits and tags:- version formats are highly configurable- works without any VCS, but happily reads tag information from and writescommits and tags to Git and Mercurial if available- just handles text files, so it's not specific to any programming languageInstallation============You can download and install the latest version of this software from the Python package index (PyPI) as follows::pip install --upgrade advbumpversionUsage=====**Note**: I have compiled several usage examples in ``EXAMPLES.rst``.There are two modes of operation: On the command line for single-file operationand using a `configuration file <#configuration>`_ for more complex multi-fileoperations.::bumpversion [options] part [file]``part`` (required)The part of the version to increase, e.g. ``minor``.Valid values include those given in the ``--serialize`` / ``--parse`` option.Example bumping ``0.5.1`` to ``0.6.0``::bumpversion --current-version 0.5.1 minor src/VERSION``[file]``**default: none** (optional)The file that will be modified.If not given, the list of ``[bumpversion:file:…]`` sections from theconfiguration file will be used. If no files are mentioned on theconfiguration file either, are no files will be modified.Example bumping ``1.1.9`` to ``2.0.0``::bumpversion --current-version 1.1.9 major setup.pyConfiguration+++++++++++++All options can optionally be specified in a config file called``.bumpversion.cfg`` so that once you know how ``bumpversion`` needs to beconfigured for one particular software package, you can run it withoutspecifying options later. You should add that file to VCS so others can alsobump versions.Options on the command line take precedence over those from the config file,which take precedence over those derived from the environment and then from thedefaults.Example ``.bumpversion.cfg``::[bumpversion]current_version = 0.2.9commit = Truetag = True[bumpversion:file:setup.py]If no ``.bumpversion.cfg`` exists, ``bumpversion`` will also look into``setup.cfg`` for configuration.Global configuration--------------------General configuration is grouped in a ``[bumpversion]`` section.``current_version =``**no default value** (required)The current version of the software package before bumping.Also available as ``--current-version`` (e.g. ``bumpversion --current-version 0.5.1 patch setup.py``)``new_version =``**no default value** (optional)The version of the software package after the increment. If not given will beautomatically determined.Also available as ``--new-version`` (e.g. to go from 0.5.1 directly to0.6.1: ``bumpversion --current-version 0.5.1 --new-version 0.6.1 patchsetup.py``).``tag = (True | False)``**default:** False (`Don't create a tag`)Whether to create a tag, that is the new version, prefixed with the character"``v``". If you are using git, don't forget to ``git-push`` with the``--tags`` flag.Also available on the command line as ``(--tag | --no-tag)``.``sign_tags = (True | False)``**default:** False (`Don't sign tags`)Whether to sign tags.Also available on the command line as ``(--sign-tags | --no-sign-tags)``.``tag_name =``**default:** ``v{new_version}``The name of the tag that will be created. Only valid when using ``--tag`` / ``tag = True``.This is templated using the `Python Format String Syntax<http://docs.python.org/2/library/string.html#format-string-syntax>`_.Available in the template context are ``current_version`` and ``new_version``as well as all environment variables (prefixed with ``$``). You can also usethe variables ``now`` or ``utcnow`` to get a current timestamp. Both acceptdatetime formatting (when used like as in ``{now:%d.%m.%Y}``).Also available as ``--tag-name`` (e.g. ``bumpversion --message 'Jenkins Build{$BUILD_NUMBER}: {new_version}' patch``).``tag_message =``**default:** ``Bump version: {current_version} -> {new_version}``The annotation of the tag that will be created. Only valid when using ``--tag`` / ``tag = True``.This is templated using the `Python Format String Syntax<http://docs.python.org/2/library/string.html#format-string-syntax>`_.Available in the template context are ``current_version`` and ``new_version``as well as all environment variables (prefixed with ``$``). You can also usethe variables ``now`` or ``utcnow`` to get a current timestamp. Both acceptdatetime formatting (when used like as in ``{now:%d.%m.%Y}``).Also available as ``--tag-message``.``commit = (True | False)``**default:** ``False`` (`Don't create a commit`)Whether to create a commit using git or Mercurial.Also available as ``(--commit | --no-commit)``.``message =``**default:** ``Bump version: {current_version} -> {new_version}``The commit message to use when creating a commit. Only valid when using ``--commit`` / ``commit = True``.This is templated using the `Python Format String Syntax<http://docs.python.org/2/library/string.html#format-string-syntax>`_.Available in the template context are ``current_version`` and ``new_version``as well as all environment variables (prefixed with ``$``). You can also usethe variables ``now`` or ``utcnow`` to get a current timestamp. Both acceptdatetime formatting (when used like as in ``{now:%d.%m.%Y}``).Also available as ``--message`` (e.g.: ``bumpversion --message'[{now:%Y-%m-%d}] Jenkins Build {$BUILD_NUMBER}: {new_version}' patch``)Part specific configuration---------------------------A version string consists of one or more parts, e.g. the version ``1.0.2``has three parts, separated by a dot (``.``) character. In the defaultconfiguration these parts are named `major`, `minor`, `patch`, however you cancustomize that using the ``parse``/``serialize`` option.By default all parts considered numeric, that is their initial value is ``0``and they are increased as integers. Also, the value ``0`` is considered to beoptional if it's not needed for serialization, i.e. the version ``1.4.0`` isequal to ``1.4`` if ``{major}.{minor}`` is given as a ``serialize`` value.For advanced versioning schemes, non-numeric parts may be desirable (e.g. toidentify `alpha or beta versions<http://en.wikipedia.org/wiki/Software_release_life_cycle#Stages_of_development>`_,to indicate the stage of development, the flavor of the software package ora release name). To do so, you can use a ``[bumpversion:part:…]`` sectioncontaining the part's name (e.g. a part named ``release_name`` is configured ina section called ``[bumpversion:part:release_name]``.The following options are valid inside a part configuration:``values =``**default**: numeric (i.e. ``0``, ``1``, ``2``, …)Explicit list of all values that will be iterated when bumping that specificpart.Example::[bumpversion:part:release_name]values =witty-warthogridiculous-ratmarvelous-mantis``optional_value =``**default**: The first entry in ``values =``.If the value of the part matches this value it is considered optional, i.e.it's representation in a ``--serialize`` possibility is not required.Example::[bumpversion]current_version = 1.alphaparse = (?P<num>\d+)(\.(?P<release>.*))?serialize ={num}.{release}{num}[bumpversion:part:release]optional_value = gammavalues =alphabetagammaHere, ``bumpversion release`` would bump ``1.alpha`` to ``1.beta``. Executing``bumpversion release`` again would bump ``1.beta`` to ``1``, because`release` being ``gamma`` is configured optional.``first_value =``**default**: The first entry in ``values =``.When the part is reset, the value will be set to the value specified here.``independent = ``**default**: FalseWhen this value is set to True, the part is not reset when other parts are incremented. Its incrementation isindependent of the other parts. It is in particular useful when you have a build number in your version that isincremented independently of the actual version.File specific configuration---------------------------``[bumpversion:file:…:…]``**Note**: If you want to specify different options (``parse``, ...) for the same file, you can have several sections for the same file.To distinguish these sections, append ``:`` and an identifier (its value has no importance) after the file name::[bumpversion:file.txt:0]parse = ...[bumpversion:file.txt:1]parse = ...``parse =``**default:** ``(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)``Regular expression (using `Python regular expression syntax<http://docs.python.org/2/library/re.html#regular-expression-syntax>`_) onhow to find and parse the version string.Is required to parse all strings produced by ``serialize =``. Named matchinggroups ("``(?P<name>...)``") provide values to as the ``part`` argument.Also available as ``--parse````serialize =``**default:** ``{major}.{minor}.{patch}``Template specifying how to serialize the version parts back to a versionstring.This is templated using the `Python Format String Syntax<http://docs.python.org/2/library/string.html#format-string-syntax>`_.Available in the template context are parsed values of the named groupsspecified in ``parse =`` as well as all environment variables (prefixed with``$``).Can be specified multiple times, bumpversion will try the serializationformats beginning with the first and choose the last one where all values canbe represented like this::serialize ={major}.{minor}{major}Given the example above, the new version *1.9* it will be serialized as``1.9``, but the version *2.0* will be serialized as ``2``.Also available as ``--serialize``. Multiple values on the command line aregiven like ``--serialize {major}.{minor} --serialize {major}````search =``**default:** ``{current_version}``Template string how to search for the string to be replaced in the file.Useful if the remotest possibility exists that the current version numbermight be multiple times in the file and you mean to only bump one of theoccurrences. Can be multiple lines, templated using `Python Format String Syntax<http://docs.python.org/2/library/string.html#format-string-syntax>`_.``replace =``**default:** ``{new_version}``Template to create the string that will replace the current version number inthe file.Given this ``requirements.txt``::Django>=1.5.6,<1.6MyProject==1.5.6using this ``.bumpversion.cfg`` will ensure only the line containing``MyProject`` will be changed::[bumpversion]current_version = 1.5.6[bumpversion:file:requirements.txt]search = MyProject=={current_version}replace = MyProject=={new_version}Can be multiple lines, templated using `Python Format String Syntax<http://docs.python.org/2/library/string.html#format-string-syntax>`_.Options=======Most of the configuration values above can also be given as an option.Additionally, the following options are available:``--dry-run, -n``Don't touch any files, just pretend. Best used with ``--verbose``.``--allow-dirty``Normally, bumpversion will abort if the working directory is dirty to protectyourself from releasing unversioned files and/or overwriting unsaved changes.Use this option to override this check.``--verbose``Print useful information to stderr``--list``List machine readable information to stdout for consumption by otherprograms.Example output::current_version=0.0.18new_version=0.0.19``-h, --help``Print help and exitUsing bumpversion in a script=============================If you need to use the version generated by bumpversion in a script you can make use ofthe `--list` option, combined with `grep` and `sed`.Say for example that you are using git-flow to manage your project and want to automaticallycreate a release. When you issue `git flow release start` you already need to know thenew version, before applying the change.The standard way to get it in a bash script isbumpversion --dry-run --list <part> | grep <field name> | sed -r s,"^.*=",,where <part> is as usual the part of the version number you are updating. You need to specify`--dry-run` to avoid bumpversion actually bumping the version number.For example, if you are updating the minor number and looking for the new version number this becomesbumpversion --dry-run --list minor | grep new_version | sed -r s,"^.*=",,Development===========Development of this happens on GitHub, patches including tests, documentationare very welcome, as well as bug reports! Also please open an issue if thistool does not support every aspect of bumping versions in your developmentworkflow, as it is intended to be very versatile.How to release bumpversion itself+++++++++++++++++++++++++++++++++Execute the following commands::git checkout mastergit pullmake testbumpversion releasepython setup.py sdist bdist_wheel uploadbumpversion --no-tag patchgit push origin master --tagsLicense=======**ADVbumpversion** is licensed under the MIT License - see the LICENSE.rst file for details.. _changelog:Changes=======**v1.2.0**- Add ``independent`` flag for version parts. This part is not reset when other parts are incremented. For example, forbuild numbers- Add EXAMPLES.rst with several test cases- Add new test cases: update version and build date, build number, annotated tags, test cases for almost all cases inEXAMPLES.rst**v1.1.1**- Fix a bug with PR#117: allow multiple config sections per file. Add a test case.**v1.1.0**- Compatibility with Travis CI- Publish on PyPi**v1.0.0**Fork of fork. The project is renamed **advbumpversion** to avoid confusion with other forks.The following Push requests are merged in this project:- `PR#8 <https://github.com/c4urself/bump2version/pull/8>`_ from @ekoh: Add Python 3.5 and 3.6 to the supported versions: Add Python 3.5 and 3.6 to the supported versions- `PR#117 <https://github.com/peritus/bumpversion/pull/117>`_ from from @chadawagner: allow multiple config sections per file- `PR#136 <https://github.com/peritus/bumpversion/pull/136>`_ from @vadeg: Fix documentation example with 'optional_value'- `PR#138 <https://github.com/peritus/bumpversion/pull/138>`_ from @smsearcy: Fixes TypeError in Python 3 on Windows- `PR#157 <https://github.com/peritus/bumpversion/pull/157>`_ from todd-dembrey: Fix verbose tagsI consider this project stable enough to raise the version to 1.0.0.**v0.5.7**- Added support for signing tags (git tag -s)thanks: @Californian (`#6 <https://github.com/c4urself/bump2version/pull/6>`_)**v0.5.6**- Added compatibility with `bumpversion` by making script install as `bumpversion` as wellthanks: @the-allanc (`#2 <https://github.com/c4urself/bump2version/pull/2>`_)**v0.5.5**- Added support for annotated tagsthanks: @ekohl @gvangool (`#58 <https://github.com/peritus/bumpversion/pull/58>`_)**v0.5.4**- Renamed to bump2version to ensure no conflicts with original package**v0.5.3**- Fix bug where ``--new-version`` value was not used when config was present(thanks @cscetbon @ecordell (`#60 <https://github.com/peritus/bumpversion/pull/60>`_)- Preserve case of keys config file(thanks theskumar `#75 <https://github.com/peritus/bumpversion/pull/75>`_)- Windows CRLF improvements (thanks @thebjorn)**v0.5.1**- Document file specific options ``search =`` and ``replace =`` (introduced in 0.5.0)- Fix parsing individual labels from ``serialize =`` config even if there arecharacters after the last label (thanks @mskrajnowski `#56<https://github.com/peritus/bumpversion/pull/56>`_).- Fix: Don't crash in git repositories that have tags that contain hyphens(`#51 <https://github.com/peritus/bumpversion/pull/51>`_) (`#52<https://github.com/peritus/bumpversion/pull/52>`_).- Fix: Log actual content of the config file, not what ConfigParser printsafter reading it.- Fix: Support multiline values in ``search =``- also load configuration from ``setup.cfg`` (thanks @t-8ch `#57<https://github.com/peritus/bumpversion/pull/57>`_).**v0.5.0**This is a major one, containing two larger features, that require some changesin the configuration format. This release is fully backwards compatible to*v0.4.1*, however deprecates two uses that will be removed in a future version.- New feature: `Part specific configuration <#part-specific-configuration>`_- New feature: `File specific configuration <#file-specific-configuration>`_- New feature: parse option can now span multiple line (allows to comment complexregular expressions. See `re.VERBOSE in the Python documentation<https://docs.python.org/library/re.html#re.VERBOSE>`_ for details, `thistestcase<https://github.com/peritus/bumpversion/blob/165e5d8bd308e9b7a1a6d17dba8aec9603f2d063/tests.py#L1202-L1211>`_as an example.)- New feature: ``--allow-dirty`` (`#42 <https://github.com/peritus/bumpversion/pull/42>`_).- Fix: Save the files in binary mode to avoid mutating newlines (thanks @jaraco `#45 <https://github.com/peritus/bumpversion/pull/45>`_).- License: bumpversion is now licensed under the MIT License (`#47 <https://github.com/peritus/bumpversion/issues/47>`_)- Deprecate multiple files on the command line (use a `configuration file <#configuration>`_ instead, or invoke ``bumpversion`` multiple times)- Deprecate 'files =' configuration (use `file specific configuration <#file-specific-configuration>`_ instead)**v0.4.1**- Add --list option (`#39 <https://github.com/peritus/bumpversion/issues/39>`_)- Use temporary files for handing over commit/tag messages to git/hg (`#36 <https://github.com/peritus/bumpversion/issues/36>`_)- Fix: don't encode stdout as utf-8 on py3 (`#40 <https://github.com/peritus/bumpversion/issues/40>`_)- Fix: logging of content of config file was wrong**v0.4.0**- Add --verbose option (`#21 <https://github.com/peritus/bumpversion/issues/21>`_ `#30 <https://github.com/peritus/bumpversion/issues/30>`_)- Allow option --serialize multiple times**v0.3.8**- Fix: --parse/--serialize didn't work from cfg (`#34 <https://github.com/peritus/bumpversion/issues/34>`_)**v0.3.7**- Don't fail if git or hg is not installed (thanks @keimlink)- "files" option is now optional (`#16 <https://github.com/peritus/bumpversion/issues/16>`_)- Fix bug related to dirty work dir (`#28 <https://github.com/peritus/bumpversion/issues/28>`_)**v0.3.6**- Fix --tag default (thanks @keimlink)**v0.3.5**- add {now} and {utcnow} to context- use correct file encoding writing to config file. NOTE: If you are usingPython2 and want to use UTF-8 encoded characters in your config file, youneed to update ConfigParser like using 'pip install -U configparser'- leave current_version in config even if available from vcs tags (wasconfusing)- print own version number in usage- allow bumping parts that contain non-numerics- various fixes regarding file encoding**v0.3.4**- bugfix: tag_name and message in .bumpversion.cfg didn't have an effect (`#9 <https://github.com/peritus/bumpversion/issues/9>`_)**v0.3.3**- add --tag-name option- now works on Python 3.2, 3.3 and PyPy**v0.3.2**- bugfix: Read only tags from `git describe` that look like versions**v0.3.1**- bugfix: ``--help`` in git workdir raising AssertionError- bugfix: fail earlier if one of files does not exist- bugfix: ``commit = True`` / ``tag = True`` in .bumpversion.cfg had no effect**v0.3.0**- **BREAKING CHANGE** The ``--bump`` argument was removed, this is now the firstpositional argument.If you used ``bumpversion --bump major`` before, you can use``bumpversion major`` now.If you used ``bumpversion`` without arguments before, you nowneed to specify the part (previous default was ``patch``) as in``bumpversion patch``).**v0.2.2**- add --no-commit, --no-tag**v0.2.1**- If available, use git to learn about current version**v0.2.0**- Mercurial support**v0.1.1**- Only create a tag when it's requested (thanks @gvangool)**v0.1.0**- Initial public version