c4urself / bump2version

Version-bump your software with a single command
https://pypi.python.org/pypi/bump2version
MIT License
1.06k stars 134 forks source link

Add an example to the docs around custom search patterns that need to match literal quotes #172

Closed kyluca closed 3 years ago

kyluca commented 3 years ago

As discussed in https://github.com/c4urself/bump2version/issues/165#issuecomment-717576015, a bugfix in v1.0.1 has introduced confusion for some users. This update aims to make clear the intended behaviour and configuration required for their use case.

Up until v1.0.0, a misconfigured custom search pattern could silently fallback to the default pattern and perform a match, leading the users to believe their configuration was working. In v1.0.1 that bug was fixed to avoid accidentally changing files with the default pattern when there was a typo in the custom pattern.

I believe the new behaviour is correct, and with the right configuration their use case is supported in both <=v1.0.1 AND >=v1.0.1 releases. The best thing we can do here is to update the docs to be as clear as possible.

Cheers, Kyle

Screenshot of the rendered update:

screenshot_from_2020_10_28_20_48_02