Skip to content

Commit

Permalink
Readme: minor cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
florisla committed Jan 10, 2019
1 parent 365b560 commit 6fcf481
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Expand Up @@ -139,7 +139,7 @@ General configuration is grouped in a `[bumpversion]` section.

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)
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 `current_[part]` and `new_[part]` (e.g. '`current_major`'
or '`new_patch`').
Expand All @@ -164,16 +164,16 @@ General configuration is grouped in a `[bumpversion]` section.

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)
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 `current_[part]` and `new_[part]` (e.g. '`current_major`'
or '`new_patch`').
In addition, all environment variables are exposed, prefixed with `$`.
You can also use the variables `now` or `utcnow` to get a current timestamp. Both accept
datetime formatting (when used like as in `{now:%d.%m.%Y}`).

Also available as `--message` (e.g.: `bump2version --message
'[{now:%Y-%m-%d}] Jenkins Build {$BUILD_NUMBER}: {new_version}' patch`)
Also available as command-line flag `--message`. Example usage:
`bump2version --message '[{now:%Y-%m-%d}] Jenkins Build {$BUILD_NUMBER}: {new_version}' patch`)


### Configuration file -- Part specific configuration
Expand Down Expand Up @@ -267,7 +267,7 @@ This configuration is in the section: `[bumpversion:file:…]`
Available in the template context are parsed values of the named groups
specified in `parse =` as well as all environment variables (prefixed with
`$`).

Can be specified multiple times, bumpversion will try the serialization
formats beginning with the first and choose the last one where all values can
be represented like this::
Expand All @@ -276,8 +276,8 @@ This configuration is in the section: `[bumpversion:file:…]`
{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`.
Given the example above, the new version `1.9` 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 are
given like `--serialize {major}.{minor} --serialize {major}`
Expand All @@ -287,7 +287,7 @@ This configuration is in the section: `[bumpversion:file:…]`

Template string how to search for the string to be replaced in the file.
Useful if the remotest possibility exists that the current version number
might be multiple times in the file and you mean to only bump one of the
might be present multiple times in the file and you mean to only bump one of the
occurences. Can be multiple lines, templated using [Python Format String Syntax](http://docs.python.org/2/library/string.html#format-string-syntax)

#### `replace =`
Expand Down

0 comments on commit 6fcf481

Please sign in to comment.