-
-
Notifications
You must be signed in to change notification settings - Fork 301
fix(changelog): allow rev range lookups without a tag format #623
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
While this fixes the issue, I think that the root of the problem here lies in not defining a proper default for tag_format. Mostly all parameters should have a sane default. Otherwise they come to bite you down the line, as it happens with #622
BTW the current failures in the tests haven't been introduced by this PR...
Thanks for the contribution 🎉 . Yes, we try to have defaults, but sometimes with many contributors and needs things slip through. The problems have been fixed, could you rebase and push again?
853d9ad to
08d280e
Compare
The pipelines have been cancelled?
It seems to be an error on testing. But I just retrigger it
The current default setting for `tag_format` is `None`. This is not a problem for the `bump` command, since the `normalize_tag` function defaults to `$version` when no `tag_format` is passed. However it is a problem for the `changelog` command, which seems to explicitly demand a `tag_format` in order to run a rev-range lookup. This creates issues like commitizen-tools#622. Either a sane default needs to be set for `tag_format` or the restriction in `changelog` has to be uplifted. In this commit the latter has been chosen. A test is also implemented to check that `changelog` will always compute a rev range with the default tag format. Fixes commitizen-tools#622
08d280e to
d570be1
Compare
Codecov ReportBase: 97.92% // Head: 97.92% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@ ## master #623 +/- ## ======================================= Coverage 97.92% 97.92% ======================================= Files 35 35 Lines 1252 1252 ======================================= Hits 1226 1226 Misses 26 26
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
🎉
Uh oh!
There was an error while loading. Please reload this page.
The current default setting for
tag_formatisNone. This is not a problem for thebumpcommand, since thenormalize_tagfunction defaults to$versionwhen notag_formatis passed. However it is a problem for thechangelogcommand, which seems to explicitly demand atag_formatin order to run a rev-range lookup. This creates issues like #622.Either a sane default needs to be set for
tag_formator the restriction inchangeloghas to be uplifted. In this commit the latter has been chosen. A test is also implemented to check thatchangelogwill always compute a rev range with the default tag format.Fixes #622
Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testExpected behavior
See #622
Steps to Test This Pull Request
See #622