bumpversion removes comments from setup.cfg

 ❯ cat setup.cfg
[egg_info]
#tag_build = dev

[easy_install]
index_url = http://myserver/pypi

[bumpversion]
current_version = 1.1.3

[bumpversion:file:setup.py]
 ❯ bumpversion patch --allow-dirty
 ❯ cat setup.cfg
[bumpversion]
current_version = 1.1.4

[egg_info]

[easy_install]
index_url = http://myserver/pypi

[bumpversion:file:setup.py]

That comment is used by my CI tool – on pull requests, it uncomments it to build a dev package. If bumpversion deletes it, it breaks the process.

For now, I’m switching back to using bumpversion.cfg, but I was hoping to consolidate this in setup.cfg

[peritus]

A workaround might be to use a .bumpversion.cfg will without comments that bumpversion is allowed to mess with and keep your well-commented setup.cfg just for all things that are not about bumpversion.

[schuderer]

Thanks for posting the workaround. I was also trying to consolidate the many test/build/deploy-related files in my repository a bit.

I see that bumpversion wants to stick to using ConfigParser, and that’s cool. Though when I look at it, bumpversion right now is using different mechanisms for updating the version string in the config file vs. in source code files (ConfigParser for one, the parsing mechanism for the other).

I for one wouldn’t blame the maintainers as introducing any inconsistencies 😉 (rather remove one!) if bumpversion would use ConfigParser only for reading its own config, and would use the same parsing mechanism for updating the version string in all files. Opinions?