Copyright 2019-2024 Caleb Evans
Released under the MIT license
Bump Anything is a command-line utility for incrementing the version It serves
as a more-flexible alternative to npm version
and similar tools because
Bump Anything can handle any arbitrary text file and has built-in support for
different types of projects.
- Bump the version number in any arbitrary file
- Supports most project types (if no paths are supplied, automatically detects
package.json
in Node,setup.py
orpyproject.toml
in Python,style.css
for WordPress themes, etc.)
Bump Anything requires Python 3.9 or newer to run, so please ensure you have it installed.
pip3 install bump-anything
Bump Anything exposes to your shell a bump-anything
command (also aliased to
bump
). The only required argument is a keyword indicating how you want to
increment each version. It can be either major
, minor
, or patch
.
bump major # 1.2.3 -> 2.0.0
bump minor # 1.2.3 -> 1.3.0
bump patch # 1.2.3 -> 1.2.4
bump prerelease # 1.2.3-beta.1 -> 1.2.3-beta.2
bump 2.3.4
bump v2.3.4 # same as `bump 2.3.4`
With this syntax, Bump Anything will do its best to find the relevant files to bump. However, Bump Anything can also accept an optional list of one or more file paths whose versions to bump. Only the first occurrence of the version field in each file will be updated.
bump minor subdir/myfile1.json subdir/myfile2.toml
The bump
command will automatically create a tagged commit if the current
directory is a Git repository. Only the files that have been modified by bump
will be staged.
You can explicitly specify the commit message with --commit-message
or -m
.
The default is Prepare v<new_version> release
. You can use the {new_version}
placeholder to represent the new version (without any prefix).
bump --commit-message 'Release v{new_version}' major
bump -m 'Release v{new_version}' major
You can explicitly specify the tag name with --tag-name
or -t
(default:
v<new_version>
). You can use the {new_version}
placeholder to represent the
new version (without any prefix).
bump --tag-name 'release/{new_version}' patch
bump -t 'release/{new_version}' patch
If you do not wish for bump
to automatically create a commit and tag, you can
pass the --no-commit
flag (alias: -n
):
bump --no-commit minor
bump -n minor
If you wish to disable the automatic tag creation but still create a commit, you
can pass the --no-tag
flag:
bump --no-tag patch
package.json
(Node)package-lock.json
(Node)setup.py
(Python)pyproject.toml
(Python)style.css
(WordPress Theme)<cwd name>.php
(WordPress Plugin)