bump-my-version


Namebump-my-version JSON
Version 0.28.1 PyPI version JSON
download
home_pageNone
SummaryVersion bump your Python project
upload_time2024-11-03 13:23:52
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2013-2014 Filip Noetzel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords bumpversion release version
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Bump My Version

[![image](https://img.shields.io/pypi/v/bump-my-version.svg)](https://pypi.org/project/bump-my-version/)
[![image](https://img.shields.io/pypi/l/bump-my-version.svg)](https://github.com/callowayproject/bump-my-version/blob/master/LICENSE)
[![image](https://img.shields.io/pypi/pyversions/bump-my-version.svg)](https://pypi.org/project/bump-my-version/)
[![codecov](https://codecov.io/gh/callowayproject/bump-my-version/branch/master/graph/badge.svg?token=D1GSOtWEPU)](https://codecov.io/gh/callowayproject/bump-my-version)
[![GitHub Actions](https://github.com/callowayproject/bump-my-version/workflows/CI/badge.svg)](https://github.com/callowayproject/bump-my-version/actions)

> **NOTE**
>
> 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:
>
> - Add support for `pyproject.toml` configuration files.
> - 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
> - Add better configuration validation using [Pydantic](https://docs.pydantic.dev)
> - Make the code and tests easier to read and maintain

<!--start-->

## Overview

Bump My Version's purpose is to:

- Work as a part of an automated build system
- Manage project versioning through the project's development life cycle
    - Incrementing version numbers
    - serializing version numbers
    - parsing version numbers
    - supporting SemVer, CalVer, and other versioning schemes
- Modify project files as part of the project's development life cycle
- Work with the project's source control system
    - Committing changes
    - Tagging releases
    - Reading version numbers from tags

## Installation

You can download and install the latest version of this software from the Python package index (PyPI) as follows:

```console
pip install --upgrade bump-my-version
```

## Changelog

Please find the changelog here: [CHANGELOG.md](https://github.com/callowayproject/bump-my-version/blob/master/CHANGELOG.md)

## Semantic versioning example
<!--tutorial start-->

### Create a default configuration

The default configuration uses a simplified version of [semantic versioning](https://semver.org/).

```console title="Generating a default configuration"
$ bump-my-version sample-config --no-prompt --destination .bumpversion.toml
$ cat .bumpversion.toml
[tool.bumpversion]
current_version = "0.1.0"
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
serialize = ["{major}.{minor}.{patch}"]
search = "{current_version}"
replace = "{new_version}"
regex = false
ignore_missing_version = false
tag = false
sign_tags = false
tag_name = "v{new_version}"
tag_message = "Bump version: {current_version} → {new_version}"
allow_dirty = false
commit = false
message = "Bump version: {current_version} → {new_version}"
commit_args = ""
```

### Visualize the versioning path

You can see the potential versioning paths with the `show-bump` subcommand.

```console title="Showing the potential versioning path"
$ bump-my-version show-bump
0.1.0 ── bump ─┬─ major ─ 1.0.0
               ├─ minor ─ 0.2.0
               ╰─ patch ─ 0.1.1
$ bump-my-version show-bump 1.2.3
1.2.3 ── bump ─┬─ major ─ 2.0.0
               ├─ minor ─ 1.3.0
               ╰─ patch ─ 1.2.4
```

The default configuration only allows bumping the major, minor, or patch version. What if you wanted to support pre-release versions?

### Add support for pre-release versions

Alter 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. 

```toml title="New parse configuration"
parse = """(?x)
    (?P<major>0|[1-9]\\d*)\\.
    (?P<minor>0|[1-9]\\d*)\\.
    (?P<patch>0|[1-9]\\d*)
    (?:
        -                             # dash separator for pre-release section
        (?P<pre_l>[a-zA-Z-]+)         # pre-release label
        (?P<pre_n>0|[1-9]\\d*)        # pre-release version number
    )?                                # pre-release section is optional
"""
```

Alter the `serialize` configuration to support pre-release versions.

```toml title="New serialize configuration"
serialize = [
    "{major}.{minor}.{patch}-{pre_l}{pre_n}",
    "{major}.{minor}.{patch}",
]
```

Add a new configuration section for the `pre_l` part.

```toml title="New pre_l configuration"

[tool.bumpversion.parts.pre_l]
values = ["dev", "rc", "final"]
optional_value = "final"
```

### Visualize the new versioning path

Now when you run `bump-my-version show-bump`, you can see the new pre-release versioning path.

```console title="Showing the new versioning path"
$ bump-my-version show-bump
0.1.0 ── bump ─┬─ major ─ 1.0.0-dev0
               ├─ minor ─ 0.2.0-dev0
               ├─ patch ─ 0.1.1-dev0
               ├─ pre_l ─ invalid: The part has already the maximum value among ['dev', 'rc', 'final'] and cannot be bumped.
               ╰─ pre_n ─ 0.1.0-final1
```

The `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.

If we run `bump-my-version show-bump 1.0.0-dev0`, we can see the new versioning path for a `dev` starting version.

```console title="Showing the new versioning path for a dev version"
$ bump-my-version show-bump 1.0.0-dev0
1.0.0-dev0 ── bump ─┬─ major ─ 2.0.0-dev0
                    ├─ minor ─ 1.1.0-dev0
                    ├─ patch ─ 1.0.1-dev0
                    ├─ pre_l ─ 1.0.0-rc0
                    ╰─ pre_n ─ 1.0.0-dev1
```

Finally, we can see the new versioning path for a `rc` starting version.

```console title="Showing the new versioning path for an rc version"
$ bump-my-version show-bump 1.0.0-rc0 
1.0.0-rc0 ── bump ─┬─ major ─ 2.0.0-dev0
                   ├─ minor ─ 1.1.0-dev0
                   ├─ patch ─ 1.0.1-dev0
                   ├─ pre_l ─ 1.0.0
                   ╰─ pre_n ─ 1.0.0-rc1
```

The full development and release path is:

- `1.0.0`
- `bump patch` → `1.0.1-dev0`
- `bump pre_n` → `1.0.1-dev1`
- `bump pre_l` → `1.0.1-rc0`
- `bump pre_n` → `1.0.1-rc1`
- `bump pre_l` → `1.0.1`

1. You must decide on the next version before you start developing.
2. Development versions increase using `bump-my-version bump pre_n`.
3. Switch from development to release candidate using `bump-my-version bump pre_l`.
4. Release candidates increase using `bump-my-version bump pre_n`.
5. Switch from the release candidate to the final release using `bump-my-version bump pre_l`.

### Automate the pre-release numbering

The `pre_n` or pre-release number is a number that increases with each pre-release. You can automate this by changing the serialization configuration.

```toml title="Serialize configuration with pre_n automation"
serialize = [
    "{major}.{minor}.{patch}-{pre_l}{distance_to_latest_tag}",
    "{major}.{minor}.{patch}",
]
```

The `distance_to_latest_tag` is a special value that is 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.

### Visualize the pre_n versioning path

Now when you run `bump-my-version show-bump`, you can see the new pre-release versioning path.

```console title="Showing the new versioning path with pre_n automation"
$ bump-my-version show-bump
0.1.0 ── bump ─┬─ major ─ 1.0.0-dev0
               ├─ minor ─ 0.2.0-dev0
               ├─ patch ─ 0.1.1-dev0
               ╰─ pre_l ─ invalid: The part has already the maximum value among ['dev', 'rc', 'final'] and cannot be bumped.
$ bump-my-version show-bump 1.0.0-dev0
1.0.0-dev0 ── bump ─┬─ major ─ 2.0.0-dev0
                    ├─ minor ─ 1.1.0-dev0
                    ├─ patch ─ 1.0.1-dev0
                    ╰─ pre_l ─ 1.0.0-rc0
$ bump-my-version show-bump 1.0.0-rc0 
1.0.0-rc0 ── bump ─┬─ major ─ 2.0.0-dev0
                   ├─ minor ─ 1.1.0-dev0
                   ├─ patch ─ 1.0.1-dev0
                   ╰─ pre_l ─ 1.0.0
```

The `pre_n` path is now missing because it is automated.

The full development and release path now is:

- `1.0.0`
- `bump patch` → `1.0.1-dev0`
  - each commit will increase → `1.0.1-dev1`
- `bump pre_l` → `1.0.1-rc0`
  - each commit will increase → `1.0.1-rc1`
- `bump pre_l` → `1.0.1`

1. You must decide on the next version before you start developing.
2. Development versions increase automatically with each commit.
3. Switch from development to release candidate using `bump-my-version bump pre_l`.
4. Release candidate versions increase automatically with each commit.
5. Switch from the release candidate to the final release using `bump-my-version bump pre_l`.

<!--tutorial end-->

### GitHub Actions

You 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.

```yaml title="GitHub Actions Workflow"
name: Bump version

on:
  workflow_dispatch:
    inputs:
      bump-type:
        description: 'Bump type'
        required: true
        default: 'patch'
        type: choice
        options:
        - major
        - minor
        - patch

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the code
        uses: actions/checkout@v4

      - name: Bump version
        id: bump
        uses: callowayproject/bump-my-version@master
        env:
          BUMPVERSION_TAG: "true"
        with:
          args: ${{ inputs.bump-type }}
          github-token: ${{ secrets.GH_TOKEN }}

      - name: Check
        if: steps.bump.outputs.bumped == 'true'
        run: |
          echo "Version was bumped from ${{ steps.bump.outputs.previous-version }} to ${{ steps.bump.outputs.current-version }}!"
```

Inputs for the bump-my-version action are:
1. `args` - The arguments to pass to the `bump-my-version bump [args]` command. See the CLI documentation for more information.
2. `github-token` - The GitHub token to use for committing and tagging. This is optional.

Output:
1. `bumped` - Boolean flag for whether the version was bumped.
2. `previous-version` - Version before bump was performed.
3. `current-version` - Version after performing bump.

If 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). 

## Development & Contributing

Thank you, contributors! You can find a full list here: https://github.com/callowayproject/bump-my-version/graphs/contributors

See also our [CONTRIBUTING.md](https://github.com/callowayproject/bump-my-version/blob/master/CONTRIBUTING.md)

Development 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
workflow, as it is intended to be very versatile.

## License

Bump My Version is licensed under the MIT License - see the [LICENSE](https://github.com/callowayproject/bump-my-version/blob/master/LICENSE) file for details

<!--end-->

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bump-my-version",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "bumpversion, release, version",
    "author": null,
    "author_email": "Corey Oordt <coreyoordt@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/1d/44/8f4f5dc472a054634bffd86e4941b2624e0b050f15578d40ec15e670d8e5/bump_my_version-0.28.1.tar.gz",
    "platform": null,
    "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<!--start-->\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 version numbers\n    - serializing version numbers\n    - parsing version numbers\n    - supporting SemVer, CalVer, and other versioning schemes\n- Modify project files as part of the project's development life cycle\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\nYou can download and install the latest version of this software from the Python package index (PyPI) as follows:\n\n```console\npip install --upgrade 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<!--tutorial start-->\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<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\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} \u2192 {new_version}\"\nallow_dirty = false\ncommit = false\nmessage = \"Bump version: {current_version} \u2192 {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 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 1.0.0\n               \u251c\u2500 minor \u2500 0.2.0\n               \u2570\u2500 patch \u2500 0.1.1\n$ bump-my-version show-bump 1.2.3\n1.2.3 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 2.0.0\n               \u251c\u2500 minor \u2500 1.3.0\n               \u2570\u2500 patch \u2500 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### 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    (?P<major>0|[1-9]\\\\d*)\\\\.\n    (?P<minor>0|[1-9]\\\\d*)\\\\.\n    (?P<patch>0|[1-9]\\\\d*)\n    (?:\n        -                             # dash separator for pre-release section\n        (?P<pre_l>[a-zA-Z-]+)         # pre-release label\n        (?P<pre_n>0|[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 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 1.0.0-dev0\n               \u251c\u2500 minor \u2500 0.2.0-dev0\n               \u251c\u2500 patch \u2500 0.1.1-dev0\n               \u251c\u2500 pre_l \u2500 invalid: The part has already the maximum value among ['dev', 'rc', 'final'] and cannot be bumped.\n               \u2570\u2500 pre_n \u2500 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 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 2.0.0-dev0\n                    \u251c\u2500 minor \u2500 1.1.0-dev0\n                    \u251c\u2500 patch \u2500 1.0.1-dev0\n                    \u251c\u2500 pre_l \u2500 1.0.0-rc0\n                    \u2570\u2500 pre_n \u2500 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 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 2.0.0-dev0\n                   \u251c\u2500 minor \u2500 1.1.0-dev0\n                   \u251c\u2500 patch \u2500 1.0.1-dev0\n                   \u251c\u2500 pre_l \u2500 1.0.0\n                   \u2570\u2500 pre_n \u2500 1.0.0-rc1\n```\n\nThe full development and release path is:\n\n- `1.0.0`\n- `bump patch` \u2192 `1.0.1-dev0`\n- `bump pre_n` \u2192 `1.0.1-dev1`\n- `bump pre_l` \u2192 `1.0.1-rc0`\n- `bump pre_n` \u2192 `1.0.1-rc1`\n- `bump pre_l` \u2192 `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\"\nserialize = [\n    \"{major}.{minor}.{patch}-{pre_l}{distance_to_latest_tag}\",\n    \"{major}.{minor}.{patch}\",\n]\n```\n\nThe `distance_to_latest_tag` is a special value that is 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 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 1.0.0-dev0\n               \u251c\u2500 minor \u2500 0.2.0-dev0\n               \u251c\u2500 patch \u2500 0.1.1-dev0\n               \u2570\u2500 pre_l \u2500 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 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 2.0.0-dev0\n                    \u251c\u2500 minor \u2500 1.1.0-dev0\n                    \u251c\u2500 patch \u2500 1.0.1-dev0\n                    \u2570\u2500 pre_l \u2500 1.0.0-rc0\n$ bump-my-version show-bump 1.0.0-rc0 \n1.0.0-rc0 \u2500\u2500 bump \u2500\u252c\u2500 major \u2500 2.0.0-dev0\n                   \u251c\u2500 minor \u2500 1.1.0-dev0\n                   \u251c\u2500 patch \u2500 1.0.1-dev0\n                   \u2570\u2500 pre_l \u2500 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` \u2192 `1.0.1-dev0`\n  - each commit will increase \u2192 `1.0.1-dev1`\n- `bump pre_l` \u2192 `1.0.1-rc0`\n  - each commit will increase \u2192 `1.0.1-rc1`\n- `bump pre_l` \u2192 `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<!--tutorial end-->\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<!--end-->\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2013-2014 Filip Noetzel  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Version bump your Python project",
    "version": "0.28.1",
    "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"
    },
    "split_keywords": [
        "bumpversion",
        " release",
        " version"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad2c10f770bf71116ecfcc8b2e67dd6752e7e135998579bc1dc98a6edb47bafc",
                "md5": "d52d514c4b7fd4949beea4e05617b0c0",
                "sha256": "df7fdb02a1b43c122a6714df6d1fe4efc7a1220b5638ca5a0eb3018813c1b222"
            },
            "downloads": -1,
            "filename": "bump_my_version-0.28.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d52d514c4b7fd4949beea4e05617b0c0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 52210,
            "upload_time": "2024-11-03T13:23:49",
            "upload_time_iso_8601": "2024-11-03T13:23:49.136109Z",
            "url": "https://files.pythonhosted.org/packages/ad/2c/10f770bf71116ecfcc8b2e67dd6752e7e135998579bc1dc98a6edb47bafc/bump_my_version-0.28.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1d448f4f5dc472a054634bffd86e4941b2624e0b050f15578d40ec15e670d8e5",
                "md5": "44d01454a071cb550fbd2aef8d1506f4",
                "sha256": "e608def5191baf505b6cde88bd679a0a95fc4cfeace4247adb60ac0f8a7e57ee"
            },
            "downloads": -1,
            "filename": "bump_my_version-0.28.1.tar.gz",
            "has_sig": false,
            "md5_digest": "44d01454a071cb550fbd2aef8d1506f4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 983509,
            "upload_time": "2024-11-03T13:23:52",
            "upload_time_iso_8601": "2024-11-03T13:23:52.046786Z",
            "url": "https://files.pythonhosted.org/packages/1d/44/8f4f5dc472a054634bffd86e4941b2624e0b050f15578d40ec15e670d8e5/bump_my_version-0.28.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-03 13:23:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "callowayproject",
    "github_project": "bump-my-version",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "bump-my-version"
}
        
Elapsed time: 0.40525s