callowayproject/bump-my-version

Example of basic config file

Closed this issue · 0 comments

Description

There currently is no easy to find example of a basic configuration file in the docs

At the moment a new user would have to assemble a config file by referring to some relatively deeply buried details here:
https://callowayproject.github.io/bump-my-version/reference/configuration.html#toml-example

And here:
https://callowayproject.github.io/bump-my-version/reference/configuration.html#toml-configuration-files

So a complete example might look like:

[tool.bumpversion]
allow_dirty = false
commit = false
message = "Bump version: {current_version} → {new_version}"
commit_args = ""
tag = false
sign_tags = false
tag_name = "v{new_version}"
tag_message = "Bump version: {current_version} → {new_version}"
current_version = "1.0.0"
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
serialize = [
    "{major}.{minor}.{patch}"
]
search = "{current_version}"
replace = "{new_version}"

[[tool.bumpversion.files]]
filename = "setup.py"