No rewrite config file when bumping #90
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
I agree that bumpversion should not rewrite its configuration file. I've lost commented-out lines on multiple occasions and that should not happen. This is a promising approach! However currently many unit tests are failing using this change; could you perhaps look into that? |
Owner
|
Agree, rewriting is a bit annoying; and that's not really being a good citizen towards other things in setup.cfg |
This was referenced Oct 2, 2020
jccurtis
pushed a commit
to lbl-anp/becquerel
that referenced
this pull request
Oct 5, 2021
… rewriting the setup.cfg during version bumps which cause pre-commit to fail. See: * c4urself/bump2version#90 * c4urself/bump2version#163
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I find a bit annoying that when you bumpversion the format of the configuration file changes because it's completely rewritten. This was mostly ok with a
.bumpversionfile, but now that I have moved the bumpversion configuration tosetup.cfgit's worse. For example, I like to keep sections for different services separated by two empty lines, which are reduced to one when I bumpversion. This also affects #87.I wonder if it's at all necessary to rewrite the whole config file every time you bump. It seems the only thing it changes in the file is that you bump the version of
current_version, so the same thing could be achieved by treating the config file as any other file to bump.I've implemented this here and seems to work, but I don't understand the internals of bump2version very well and I may be missing some important subtlety.