Skip to content

Commit 1b1d910

Browse files
committed
Updated the readme
1 parent 696503f commit 1b1d910

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

README.md

+5-15
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
[![image](https://img.shields.io/pypi/v/bump-my-version.svg)](https://pypi.org/project/bump-my-version/)
44
[![image](https://img.shields.io/pypi/l/bump-my-version.svg)](https://pypi.org/project/bump-my-version/)
55
[![image](https://img.shields.io/pypi/pyversions/bump-my-version.svg)](https://pypi.org/project/bump-my-version/)
6+
[![codecov](https://codecov.io/gh/callowayproject/bump-my-version/branch/master/graph/badge.svg?token=D1GSOtWEPU)](https://codecov.io/gh/callowayproject/bump-my-version)
67
[![GitHub Actions](https://github.com/callowayproject/bump-my-version/workflows/CI/badge.svg)](https://github.com/callowayproject/bump-my-version/actions)
78

89
> **NOTE**
910
>
10-
> This is a maintained refactor of the [bump2version fork of](https://github.com/c4urself/bump2version) the excellent [bumpversion project](https://github.com/peritus/bumpversion). The main goals of this refactor were:
11+
> 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:
1112
>
1213
> - Add support for `pyproject.toml` configuration files.
1314
> - 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
@@ -19,9 +20,7 @@
1920

2021
Version-bump your software with a single command!
2122

22-
A small command line tool to simplify releasing software by updating all
23-
version strings in your source code by the correct increment. Also creates
24-
commits and tags:
23+
A small command line tool to simplify releasing software by updating all version strings in your source code by the correct increment and optionally commit and tag the changes.
2524

2625
* version formats are highly configurable
2726
* works without any source code manager, but happily reads tag information from and writes
@@ -35,18 +34,11 @@ commits and tags:
3534
- Switch having both the version part and files to change as arguments on the command line.
3635
- Make the version part argument _truly_ optional when `--new-version` is specified
3736
- Allow for multiple tags, including one that moves for having a `v2` that always points to the latest version of version 2.
38-
- https://github.com/c4urself/bump2version/issues/253 Have an always increment configuration
37+
- https://github.com/c4urself/bump2version/issues/253 Have an "always increment" configuration
3938
- Better UI with [Rich](https://rich.readthedocs.io/en/stable/index.html)
40-
41-
**Potential bugs to verify**
42-
4339
- https://github.com/c4urself/bump2version/issues/267 Ignore-missing error in files flag
44-
- Fixed: https://github.com/c4urself/bump2version/issues/260 Incorrect behavior when new version == current version
45-
- https://github.com/c4urself/bump2version/issues/248 Potential bug/test case
46-
- https://github.com/c4urself/bump2version/issues/246 Release inconsistency
4740
- https://github.com/c4urself/bump2version/issues/233 How are relative configured file paths resolved?
4841
- https://github.com/c4urself/bump2version/issues/225 Properly resolve configuration file through parent directories when in a git or mercurial repo
49-
- Fixed: https://github.com/c4urself/bump2version/issues/224 Verify tag doesn't exist
5042

5143
**Documentation opportunities**
5244

@@ -169,9 +161,7 @@ Thank you, contributors! You can find a full list here: https://github.com/callo
169161

170162
See also our [CONTRIBUTING.md](CONTRIBUTING.md)
171163

172-
Development of this happens on GitHub, patches including tests, and documentation
173-
are very welcome, as well as bug reports! Also please open an issue if this
174-
tool does not support every aspect of bumping versions in your development
164+
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
175165
workflow, as it is intended to be very versatile.
176166

177167
## License

0 commit comments

Comments
 (0)