{"author":null,"author_email":"Corey Oordt ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Console","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: PyPy","Topic :: Software Development :: Build Tools","Topic :: Software Development :: Version Control","Topic :: System :: Software Distribution"],"description":"# Bump My Version\n\n[![image](https://img.shields.io/pypi/v/bump-my-version.svg)](https://pypi.org/project/bump-my-version/)\n[![image](https://img.shields.io/pypi/l/bump-my-version.svg)](https://github.com/callowayproject/bump-my-version/blob/master/LICENSE)\n[![image](https://img.shields.io/pypi/pyversions/bump-my-version.svg)](https://pypi.org/project/bump-my-version/)\n[![codecov](https://codecov.io/gh/callowayproject/bump-my-version/branch/master/graph/badge.svg?token=D1GSOtWEPU)](https://codecov.io/gh/callowayproject/bump-my-version)\n[![GitHub Actions](https://github.com/callowayproject/bump-my-version/workflows/CI/badge.svg)](https://github.com/callowayproject/bump-my-version/actions)\n\n> **NOTE**\n>\n> This is a maintained refactor of the [bump2version fork](https://github.com/c4urself/bump2version) of the excellent [bumpversion project](https://github.com/peritus/bumpversion). The main goals of this refactor were:\n>\n> - Add support for `pyproject.toml` configuration files.\n> - Convert to [click](https://click.palletsprojects.com/en/8.1.x/) for and [rich](https://rich.readthedocs.io/en/stable/index.html) for the CLI interface\n> - Add better configuration validation using [Pydantic](https://docs.pydantic.dev)\n> - Make the code and tests easier to read and maintain\n\n\n\n## Overview\n\nBump My Version's purpose is to:\n\n- Work as a part of an automated build system\n- Manage project versioning through the project's development life cycle\n - Incrementing and serializing version numbers\n - parsing version numbers\n - supporting SemVer, CalVer, and other versioning schemes\n- Search and replace data in project files\n- Work with the project's source control system\n - Committing changes\n - Tagging releases\n - Reading version numbers from tags\n\n## Installation\n\nTo install Bump My Version as an independent tool, use [uv](https://docs.astral.sh/uv/getting-started/installation/) to install it on your system.\n\n```console\nuv tool install bump-my-version\n```\n\n## Changelog\n\nPlease find the changelog here: [CHANGELOG.md](https://github.com/callowayproject/bump-my-version/blob/master/CHANGELOG.md)\n\n## Semantic versioning example\n\n\n### Create a default configuration\n\nThe default configuration uses a simplified version of [semantic versioning](https://semver.org/).\n\n```console title=\"Generating a default configuration\"\n$ bump-my-version sample-config --no-prompt --destination .bumpversion.toml\n$ cat .bumpversion.toml\n[tool.bumpversion]\ncurrent_version = \"0.1.0\"\nparse = \"(?P\\\\d+)\\\\.(?P\\\\d+)\\\\.(?P\\\\d+)\"\nserialize = [\"{major}.{minor}.{patch}\"]\nsearch = \"{current_version}\"\nreplace = \"{new_version}\"\nregex = false\nignore_missing_version = false\ntag = false\nsign_tags = false\ntag_name = \"v{new_version}\"\ntag_message = \"Bump version: {current_version} → {new_version}\"\nallow_dirty = false\ncommit = false\nmessage = \"Bump version: {current_version} → {new_version}\"\ncommit_args = \"\"\n```\n\n### Visualize the versioning path\n\nYou can see the potential versioning paths with the `show-bump` subcommand.\n\n```console title=\"Showing the potential versioning path\"\n$ bump-my-version show-bump\n0.1.0 ── bump ─┬─ major ─ 1.0.0\n ├─ minor ─ 0.2.0\n ╰─ patch ─ 0.1.1\n$ bump-my-version show-bump 1.2.3\n1.2.3 ── bump ─┬─ major ─ 2.0.0\n ├─ minor ─ 1.3.0\n ╰─ patch ─ 1.2.4\n```\n\nThe default configuration only allows bumping the major, minor, or patch version. What if you wanted to support pre-release versions?\n\n### Get the new version in a script\n\nIf you want to get the new version within a script, you can use the [`show`](https://callowayproject.github.io/bump-my-version/reference/cli/#bump-my-version-show) method.\n\n```console title=\"Extract the new version\"\n$ bump-my-version show current_version\n1.2.3\n$ bump-my-version show --increment minor new_version\n1.3.3\n```\n\n\n### Add support for pre-release versions\n\nAlter the `parse` configuration to support pre-release versions. This `parse` option uses an extended (or verbose) regular expression to extract the version components from the current version. \n\n```toml title=\"New parse configuration\"\nparse = \"\"\"(?x)\n (?P0|[1-9]\\\\d*)\\\\.\n (?P0|[1-9]\\\\d*)\\\\.\n (?P0|[1-9]\\\\d*)\n (?:\n - # dash separator for pre-release section\n (?P[a-zA-Z-]+) # pre-release label\n (?P0|[1-9]\\\\d*) # pre-release version number\n )? # pre-release section is optional\n\"\"\"\n```\n\nAlter the `serialize` configuration to support pre-release versions.\n\n```toml title=\"New serialize configuration\"\nserialize = [\n \"{major}.{minor}.{patch}-{pre_l}{pre_n}\",\n \"{major}.{minor}.{patch}\",\n]\n```\n\nAdd a new configuration section for the `pre_l` part.\n\n```toml title=\"New pre_l configuration\"\n\n[tool.bumpversion.parts.pre_l]\nvalues = [\"dev\", \"rc\", \"final\"]\noptional_value = \"final\"\n```\n\n### Visualize the new versioning path\n\nNow when you run `bump-my-version show-bump`, you can see the new pre-release versioning path.\n\n```console title=\"Showing the new versioning path\"\n$ bump-my-version show-bump\n0.1.0 ── bump ─┬─ major ─ 1.0.0-dev0\n ├─ minor ─ 0.2.0-dev0\n ├─ patch ─ 0.1.1-dev0\n ├─ pre_l ─ invalid: The part has already the maximum value among ['dev', 'rc', 'final'] and cannot be bumped.\n ╰─ pre_n ─ 0.1.0-final1\n```\n\nThe `pre_l` is not bump-able because it is already at the maximum value. The `pre_n` is bump-able because it is not at the maximum value.\n\nIf we run `bump-my-version show-bump 1.0.0-dev0`, we can see the new versioning path for a `dev` starting version.\n\n```console title=\"Showing the new versioning path for a dev version\"\n$ bump-my-version show-bump 1.0.0-dev0\n1.0.0-dev0 ── bump ─┬─ major ─ 2.0.0-dev0\n ├─ minor ─ 1.1.0-dev0\n ├─ patch ─ 1.0.1-dev0\n ├─ pre_l ─ 1.0.0-rc0\n ╰─ pre_n ─ 1.0.0-dev1\n```\n\nFinally, we can see the new versioning path for a `rc` starting version.\n\n```console title=\"Showing the new versioning path for an rc version\"\n$ bump-my-version show-bump 1.0.0-rc0 \n1.0.0-rc0 ── bump ─┬─ major ─ 2.0.0-dev0\n ├─ minor ─ 1.1.0-dev0\n ├─ patch ─ 1.0.1-dev0\n ├─ pre_l ─ 1.0.0\n ╰─ pre_n ─ 1.0.0-rc1\n```\n\nThe full development and release path is:\n\n- `1.0.0`\n- `bump patch` → `1.0.1-dev0`\n- `bump pre_n` → `1.0.1-dev1`\n- `bump pre_l` → `1.0.1-rc0`\n- `bump pre_n` → `1.0.1-rc1`\n- `bump pre_l` → `1.0.1`\n\n1. You must decide on the next version before you start developing.\n2. Development versions increase using `bump-my-version bump pre_n`.\n3. Switch from development to release candidate using `bump-my-version bump pre_l`.\n4. Release candidates increase using `bump-my-version bump pre_n`.\n5. Switch from the release candidate to the final release using `bump-my-version bump pre_l`.\n\n### Automate the pre-release numbering\n\nThe `pre_n` or pre-release number is a number that increases with each pre-release. You can automate this by changing the serialization configuration.\n\n```toml title=\"Serialize configuration with pre_n automation\"\nparse = \"\"\"(?x)\n (?P0|[1-9]\\\\d*)\\\\.\n (?P0|[1-9]\\\\d*)\\\\.\n (?P0|[1-9]\\\\d*)\n (?:\n - # dash separator for pre-release section\n (?P[a-zA-Z-]+) # pre-release label\n (?:0|[1-9]\\\\d*) # pre-release version number\n )? # pre-release section is optional\n\"\"\"\n\nserialize = [\n \"{major}.{minor}.{patch}-{pre_l}{distance_to_latest_tag}\",\n \"{major}.{minor}.{patch}\",\n]\n```\n\nNow the `pre_n` is no longer captured in the `parse` expression and `serialize` replaces `pre_n` with `distance_to_latest_tag`. The `distance_to_latest_tag` is a special value replaced with the number of commits since the last tag. This is a good value to use for the `pre_n` because it will always increase with each commit.\n\n### Visualize the pre_n versioning path\n\nNow when you run `bump-my-version show-bump`, you can see the new pre-release versioning path.\n\n```console title=\"Showing the new versioning path with pre_n automation\"\n$ bump-my-version show-bump\n0.1.0 ── bump ─┬─ major ─ 1.0.0-dev0\n ├─ minor ─ 0.2.0-dev0\n ├─ patch ─ 0.1.1-dev0\n ╰─ pre_l ─ invalid: The part has already the maximum value among ['dev', 'rc', 'final'] and cannot be bumped.\n$ bump-my-version show-bump 1.0.0-dev0\n1.0.0-dev0 ── bump ─┬─ major ─ 2.0.0-dev0\n ├─ minor ─ 1.1.0-dev0\n ├─ patch ─ 1.0.1-dev0\n ╰─ pre_l ─ 1.0.0-rc0\n$ bump-my-version show-bump 1.0.0-rc0 \n1.0.0-rc0 ── bump ─┬─ major ─ 2.0.0-dev0\n ├─ minor ─ 1.1.0-dev0\n ├─ patch ─ 1.0.1-dev0\n ╰─ pre_l ─ 1.0.0\n```\n\nThe `pre_n` path is now missing because it is automated.\n\nThe full development and release path now is:\n\n- `1.0.0`\n- `bump patch` → `1.0.1-dev0`\n - each commit will increase → `1.0.1-dev1`\n- `bump pre_l` → `1.0.1-rc0`\n - each commit will increase → `1.0.1-rc1`\n- `bump pre_l` → `1.0.1`\n\n1. You must decide on the next version before you start developing.\n2. Development versions increase automatically with each commit.\n3. Switch from development to release candidate using `bump-my-version bump pre_l`.\n4. Release candidate versions increase automatically with each commit.\n5. Switch from the release candidate to the final release using `bump-my-version bump pre_l`.\n\n\n\n### GitHub Actions\n\nYou can use `bump-my-version` as part of a GHA workflow. Here is an example of a workflow that bumps the version, commits the change, and tags the commit.\n\n```yaml title=\"GitHub Actions Workflow\"\nname: Bump version\n\non:\n workflow_dispatch:\n inputs:\n bump-type:\n description: 'Bump type'\n required: true\n default: 'patch'\n type: choice\n options:\n - major\n - minor\n - patch\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout the code\n uses: actions/checkout@v4\n\n - name: Bump version\n id: bump\n uses: callowayproject/bump-my-version@master\n env:\n BUMPVERSION_TAG: \"true\"\n with:\n args: ${{ inputs.bump-type }}\n github-token: ${{ secrets.GH_TOKEN }}\n\n - name: Check\n if: steps.bump.outputs.bumped == 'true'\n run: |\n echo \"Version was bumped from ${{ steps.bump.outputs.previous-version }} to ${{ steps.bump.outputs.current-version }}!\"\n```\n\nInputs for the bump-my-version action are:\n1. `args` - The arguments to pass to the `bump-my-version bump [args]` command. See the CLI documentation for more information.\n2. `github-token` - The GitHub token to use for committing and tagging. This is optional.\n\nOutput:\n1. `bumped` - Boolean flag for whether the version was bumped.\n2. `previous-version` - Version before bump was performed.\n3. `current-version` - Version after performing bump.\n\nIf you want to ensure that workflows set up with on-push trigger will also start based on those newly pushed commits or tags, you need to provide a custom PAT (`github-token`). See [here](https://github.com/orgs/community/discussions/25702). \n\n## Development & Contributing\n\nThank you, contributors! You can find a full list here: https://github.com/callowayproject/bump-my-version/graphs/contributors\n\nSee also our [CONTRIBUTING.md](https://github.com/callowayproject/bump-my-version/blob/master/CONTRIBUTING.md)\n\nDevelopment of this happens on GitHub, patches including tests, and documentation are very welcome, as well as bug reports! Please open an issue if this tool does not support every aspect of bumping versions in your development\nworkflow, as it is intended to be very versatile.\n\n## License\n\nBump My Version is licensed under the MIT License - see the [LICENSE](https://github.com/callowayproject/bump-my-version/blob/master/LICENSE) file for details\n\n\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"bumpversion, release, version","license":"MIT License\n \n Copyright (c) 2013-2014 Filip Noetzel\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.","license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"bump-my-version","package_url":"https://pypi.org/project/bump-my-version/","platform":null,"project_url":"https://pypi.org/project/bump-my-version/","project_urls":{"documentation":"https://callowayproject.github.io/bump-my-version/","homepage":"https://github.com/callowayproject/bump-my-version","repository":"https://github.com/callowayproject/bump-my-version.git"},"provides_extra":null,"release_url":"https://pypi.org/project/bump-my-version/1.1.4/","requires_dist":["click","httpx>=0.28.1","pydantic-settings","pydantic>=2.0.0","questionary","rich","rich-click","tomlkit","wcmatch>=8.5.1"],"requires_python":">=3.8","summary":"Version bump your Python project","version":"1.1.4","yanked":false,"yanked_reason":null}

Dependency	Optional
click	false
httpx	false
pydantic	false
pydantic-settings	false
questionary	false
rich	false
rich-click	false
tomlkit	false
wcmatch	false

Package search

bump-my-version

project_urls

Dependencies

All package metadata

Releases