search

c4urself / bump2version

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

make --dry-run --verbose the default behavior #213

Open kmike opened 3 years ago

kmike commented 3 years ago

Hey! Usually when someone uses bump2version, they need to run --dry-run --verbose first - at least that's my experience. You may want to run it a few times as well, to get the right output.

I think usability of the tool can be improved, and some of the user mistakes prevented, if this mode becomes the default, and it is application of the changes which starts to require more effort, not dry run. To apply changes there could be a separate command, an option, maybe an interactive prompt after showing what's going to be changed.

Backwards compatibility is an issue, but there could be ways to overcome it.

florisla commented 3 years ago

This is an interesting idea.

On the other hand, lots of users run bump2version from a script or a CI pipeline, so backwards compatibility will be a huge deal breaker. We can't risk breaking people's workflow.

It's not impossible to add a flag in the config file dry-run-by-default. But I'm not sure it's worth it.

Personally, I run --dry-run a couple of times (10?) until the config is working. After that, I typically don't need it anymore.

jaap3 commented 3 years ago

I typically use --verbose --dry-run at least once before removing the --dry-run flag. Just to make sure I'm bumping the correct part. In the past I was also able to spot incorrect bumps by looking at the diff, but that has stopped working (#215)