adds a changelog tag parser to filter tags (--tag-parser; tag_parser) #537
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@hongkongkiwi sorry that it took some time to get back to making this PR. |
Codecov Report
@@ Coverage Diff @@
## master #537 +/- ##
==========================================
+ Coverage 97.92% 97.94% +0.02%
==========================================
Files 39 39
Lines 1540 1557 +17
==========================================
+ Hits 1508 1525 +17
Misses 32 32
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
…parser) The git tag parser is used to filter out undesired git tags from changelog. regex default is .* (all).
This new tag was added to a "feat:" rather than "bump:" commit.
The linter was complaining. Likely best to refactor this further.
Treats 'Unreleased' as if it is a git tag.
bhelgs
force-pushed
the
add_optional_tag_parser
branch
from
fff4d3b
to
fbabc2a
Compare
Lee-W
reviewed
Aug 21, 2022
| ], | ||
| ) | ||
| def test_changelog_tag_parser_config( | ||
| mocker, config_path, changelog_path, cli_args, line, filtered |
There was a problem hiding this comment.
Should we rename line as filter_pattern or something similar to make it even more readable?
There was a problem hiding this comment.
Maybe we could renamed filtered as is_filtered. I'm also a bit confused when reading it.
| @pytest.mark.parametrize( | ||
| "tag_parser", | ||
| [ | ||
| (None), # backwards compatibility check |
There was a problem hiding this comment.
Is the (, ) added by auto formatter? If not so, should we remove them?
Lee-W
added
issue-status: wait-for-response
pr-status: wait-for-modification
and removed
issue-status: wait-for-response
labels
robertschweizer
added a commit
to robertschweizer/commitizen
that referenced
this pull request
Mar 23, 2023
Closes commitizen-tools#519 CLI flag name: --tag-regex Heavily inspired by commitizen-tools#537, but extends it with a smart default value to exclude non-release tags. This was suggested in commitizen-tools#519 (comment)
robertschweizer
added a commit
to robertschweizer/commitizen
that referenced
this pull request
Mar 23, 2023
Closes commitizen-tools#519 CLI flag name: --tag-regex Heavily inspired by commitizen-tools#537, but extends it with a smart default value to exclude non-release tags. This was suggested in commitizen-tools#519 (comment)
4 tasks
robertschweizer
added a commit
to robertschweizer/commitizen
that referenced
this pull request
May 2, 2023
Closes commitizen-tools#519 CLI flag name: --tag-regex Heavily inspired by commitizen-tools#537, but extends it with a smart default value to exclude non-release tags. This was suggested in commitizen-tools#519 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Some repositories have tags that are not matching the
bumpversion pattern (e.g.alpha/betarelease) #519.It makes sense to be able to filter those out. See this "Expected Behavior" section for an example.
The first commit:
Subsequent commits (probably best reviewing each commit individually):
if(by avoiding an optional).Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testExpected behavior
originally:
once filtered with
cz changelog --dry-run --tag-parser 'v[0-9]*\.[0-9]*\.[0-9]*'will be:Similar can be done with the
tomloption:tag_parser: "v[0-9]*\\.[0-9]*\\.[0-9]*". Notetomlrequired an extra\.Steps to Test This Pull Request
scripts/testIn the case below there is a filterable tag as the first commit.
Question:
v1.2.0-betatag:## v1.2.0-beta?## Unreleased?## Prerelease tag: v1.2.0-beta?Additional context
#519