-
-
Notifications
You must be signed in to change notification settings - Fork 298
fix: display invalid tag information #1375
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this would be a good addition, but without the regexps in the message as it will easily flood the output.
Note that #1297 should not have introduced any new raised exception, as it was already raised before and it was the reason I made #1297 initially, to provide a workaround to this exception. So I am also interested in finding why it wasn't raised before for you and now it is.
I have setup a minimal reproducer in https://github.com/carlossg/commitizen-test
with my patch
❯ cz version; cz bump --dry-run
4.4.1
Traceback (most recent call last):
File "/opt/homebrew/bin/cz", line 8, in <module>
sys.exit(main())
~~~~^^
File "/opt/homebrew/Cellar/commitizen/4.4.1_1/libexec/lib/python3.13/site-packages/commitizen/cli.py", line 656, in main
args.func(conf, arguments)()
~~~~~~~~~~~~~~~~~~~~~~~~~~^^
File "/opt/homebrew/Cellar/commitizen/4.4.1_1/libexec/lib/python3.13/site-packages/commitizen/commands/bump.py", line 147, in __call__
current_version = self.scheme(provider.get_version())
~~~~~~~~~~~~~~~~~~~~^^
File "/opt/homebrew/Cellar/commitizen/4.4.1_1/libexec/lib/python3.13/site-packages/commitizen/providers/scm_provider.py", line 21, in get_version
versions = sorted(rules.extract_version(t) for t in version_tags)
File "/opt/homebrew/Cellar/commitizen/4.4.1_1/libexec/lib/python3.13/site-packages/commitizen/providers/scm_provider.py", line 21, in <genexpr>
versions = sorted(rules.extract_version(t) for t in version_tags)
~~~~~~~~~~~~~~~~~~~~~^^^
File "/opt/homebrew/Cellar/commitizen/4.4.1_1/libexec/lib/python3.13/site-packages/commitizen/tags.py", line 148, in extract_version
raise InvalidVersion(f"Invalid version tag: '{tag.name}' does not match any configured tag format: {regexes}")
packaging.version.InvalidVersion: Invalid version tag: '1.0.0.fb3a1d1' does not match any configured tag format: re.compile('v?(?P<version>([0-9]+)\\.([0-9]+)(?:\\.([0-9]+))?(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z.]+)?(\\w+)?)')
I can remove the regex to be less verbose
and the regex used for validation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just fix the style. Would be nice if we could add a unit test. But I'm also good with merge it as it is
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@ ## master #1375 +/- ## ========================================== + Coverage 97.33% 97.55% +0.21% ========================================== Files 42 57 +15 Lines 2104 2655 +551 ========================================== + Hits 2048 2590 +542 - Misses 56 65 +9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there is already a test for the exception itself, so I am OK to have the wording changed without a new test.
I'll take a look at the uncaught exception as soon as I have more time.
I think there is already a test for the exception itself, so I am OK to have the wording changed without a new test.
I'll take a look at the uncaught exception as soon as I have more time.
Then that's merge it and we can get back a bit later
Starting in 4.4.0 due to commitizen-tools#1297 when an invalid tag is present an exception is thrown This commit ignores the invalid tags Follow up from commitizen-tools#1375
Starting in 4.4.0 due to commitizen-tools#1297 when an invalid tag is present an exception is thrown This commit ignores the invalid tags Follow up from commitizen-tools#1375
and the regex used for validation
Description
Starting in 4.4.0 due to #1297 when an invalid tag is present an exception is thrown. I would expect the tag is ignored.
This PR only improves the message, not the root cause
Before
After
Checklist
poetry alllocally to ensure this change passes linter check and testExpected behavior
Steps to Test This Pull Request
cz bump --dry-runAdditional context