Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Defaults to --no-regex mode #59

Closed
kdeldycke opened this issue Aug 29, 2023 · 1 comment · Fixed by #80
Closed

Defaults to --no-regex mode #59

kdeldycke opened this issue Aug 29, 2023 · 1 comment · Fixed by #80
Labels
feature-request New feature or request
Milestone

Comments

@kdeldycke
Copy link
Collaborator

kdeldycke commented Aug 29, 2023

  • bump-my-version version: 0.9.3
  • Python version: 3.11.15
  • Operating System: macOS

Description

Trying to catch up with the latest releases of bump-my-version, I am happy with the new addition of the regex support! 💪

It is a powerful feature, but maybe too powerful for newcomers. That's why I would like to suggest deactivating this mode by default, and make it opt-in only (by the way of a --regex option and/or regex = true in config files).

Reasons:

  • All examples in the documentation assumes the regex mode is disabled.
  • Syntax in TOML is not the same as syntax in INI format. Adds to the confusion.
  • Reduce migration effort from bump2version and bumpversion.
  • Reduce surprises from new users.
  • The majority of cases requires a simple search and replace on constant strings.

By switching off the regex mode by default, I want to achieve an easier onboarding of new users. Which should increase the popularity of bump-my-version and reduce the support effort from maintainers.

@coordt coordt added the feature-request New feature or request label Sep 5, 2023
@coordt coordt added this to the 1.0 Release milestone Sep 5, 2023
coordt added a commit that referenced this issue Nov 4, 2023
Fixes #59

- Changed the flags to --regex/--no-regex
- updated tests and docs
@coordt coordt linked a pull request Nov 4, 2023 that will close this issue
@coordt coordt closed this as completed in #80 Nov 4, 2023
@kdeldycke
Copy link
Collaborator Author

Can confirm this has been solved! 😎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants