Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example of basic config file #122

Closed
hottwaj opened this issue Jan 9, 2024 · 0 comments · Fixed by #126
Closed

Example of basic config file #122

hottwaj opened this issue Jan 9, 2024 · 0 comments · Fixed by #126
Labels
documentation Improvements or additions to documentation

Comments

@hottwaj
Copy link

hottwaj commented Jan 9, 2024

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"
@coordt coordt added the documentation Improvements or additions to documentation label Jan 14, 2024
@coordt coordt mentioned this issue Jan 14, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants