feat: Introduce tag_regex option with smart default #692

robertschweizer · 2023-03-23T15:23:50Z

Description

Closes #519

CLI flag name: --tag-regex

Heavily inspired by #537, but extends it with a smart default value to exclude non-release tags. This was suggested in #519 (comment)

I separated commits to make review easier.

Checklist

Add test cases to all the changes you introduce
Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
Test the changes on the local machine manually
Update the documentation for the changes

Expected behavior

Steps to Test This Pull Request

Additional context

codecov · 2023-03-23T15:27:30Z

Codecov Report

Patch coverage: 97.72% and project coverage change: +0.69 🎉

Comparison is base (f04a719) 97.35% compared to head (8eea9ea) 98.04%.

❗ Current head 8eea9ea differs from pull request most recent head e58e56f. Consider uploading reports for the commit e58e56f to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #692      +/-   ##
==========================================
+ Coverage   97.35%   98.04%   +0.69%     
==========================================
  Files          42       41       -1     
  Lines        2041     1742     -299     
==========================================
- Hits         1987     1708     -279     
+ Misses         54       34      -20

Flag	Coverage Δ
unittests	`98.04% <97.72%> (+0.69%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
commitizen/bump.py	`100.00% <ø> (ø)`
commitizen/cli.py	`93.93% <ø> (-0.27%)`	⬇️
commitizen/commands/init.py	`88.03% <66.66%> (+0.59%)`	⬆️
commitizen/changelog.py	`99.43% <100.00%> (-0.07%)`	⬇️
commitizen/commands/bump.py	`97.48% <100.00%> (-0.67%)`	⬇️
commitizen/commands/changelog.py	`98.94% <100.00%> (ø)`
commitizen/defaults.py	`100.00% <100.00%> (ø)`
commitizen/git.py	`98.61% <100.00%> (+0.01%)`	⬆️
commitizen/tags.py	`100.00% <100.00%> (ø)`

... and 9 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

We've been using this default already in `normalize_tag`, but setting this value in the settings dict is cleaner.

config_path and changelog_path rely on the modified CWD provided by tmp_commitizen_project, so they should use this fixture.

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 · 2023-05-03T06:23:47Z

It looks like these changes need some reworking because they partially duplicate what was done in 3a1af6a.

Would you merge this if I rework it? It didn't get a review before.

Lee-W · 2023-06-23T10:56:41Z

commitizen/tags.py

+    VersionProtocol = Any
+
+
+def tag_from_version(


version_to_tag looks more straightforward to me

Suggested change

def tag_from_version(

def veresion_to_tag(

Lee-W · 2023-06-23T10:59:47Z

commitizen/git.py

@@ -163,7 +164,9 @@ def get_tags(dateformat: str = "%Y-%m-%d") -> List[GitTag]:
        for line in c.out.split("\n")[:-1]
    ]

-    return git_tags
+    filtered_git_tags = [t for t in git_tags if pattern.fullmatch(t.name)]


maybe we can use git command to filter . but it's not requried.

Lee-W · 2023-06-23T11:01:27Z

Hi @robertschweizer sorry for the late reply. I briefly walk through it. I like the idea and will definitely take a look after reworked 🙂

robertschweizer · 2023-06-27T10:26:45Z

Sorry, I don't have much time at the moment. I started rebasing the first commit and opened #775 to get that merged.

To continue here (not sure if I will find the time myself), it's important to consider:

My use-case is to ignore tags in the changelog that we don't care about when running cz bump --changelog. I probably don't need a tag_regex.
cz bump --changelog sets the --incremental flag. This finds the previous version with a different logic than cz bump. The first line matching version_schema's parser in the existing changelog is used as previous version.
This version is then formatted with tag_format and searched for in existing tags with a similarity threshold of 0.89.
Suspected bugs in cz changelog:
- Existing tags (get_tags() function) and --rev-range values are validated by constructing the configured version_scheme on them.
  This means it matches packaging.Version._regex instead of BaseVersion.parser.
  Both SemVer and Pep440 version providers thus use packaging's PEP440 version matcher here.
  - The two standards require different pattern matching
- --incremental uses version_schema but ignores tag_format to search changelog.
  - Probably cz bump --changelog should pass the current (previous) release version explicitly, to make searching of the existing changelog unnecessary.
    - This would probably fix my use-case already.
  - It's probably rather restrictive to require the changelog to contain the used Git tag names.
ScmProvider should really use some smarter default regex matching when a non-standard tag_format is set. Maybe using placeholders other than $version in tag_format should be deprecated to make this easier. The $version string can now be configured using version_scheme.

@Lee-W @noirbizarre

woile · 2023-09-14T17:02:08Z

Looks good, hopefully we can merge it soon

noirbizarre

Seems to go the right way.
I added a few suggestions.

noirbizarre · 2024-03-04T20:19:55Z

commitizen/commands/changelog.py

-        self.tag_format = args.get("tag_format") or self.config.settings.get(
-            "tag_format"
+        self.tag_format: str = args.get("tag_format") or self.config.settings.get(
+            "tag_format", DEFAULT_SETTINGS["tag_format"]


You don't need to inject default there, default are already loaded and overwritten by actual settings

noirbizarre · 2024-03-04T20:24:18Z

docs/config.md

+
+Type: `str`
+
+Default: Based on `tag_format`


Suggested change

Default: Based on `tag_format`

Default: Computed from `tag_format`

or

Suggested change

Default: Based on `tag_format`

Default: Extrapolated from `tag_format`

noirbizarre · 2024-03-04T20:24:56Z

poetry.toml

Not related to this PR, can you remove this ?

noirbizarre · 2024-03-04T20:28:03Z

commitizen/git.py

@@ -140,7 +141,7 @@ def get_filenames_in_commit(git_reference: str = ""):
        raise GitCommandError(c.err)


-def get_tags(dateformat: str = "%Y-%m-%d") -> List[GitTag]:
+def get_tags(dateformat: str = "%Y-%m-%d", *, pattern: re.Pattern) -> List[GitTag]:


Make the pattern filtering optional:

Suggested change

def get_tags(dateformat: str = "%Y-%m-%d", *, pattern: re.Pattern) -> List[GitTag]:

def get_tags(dateformat: str = "%Y-%m-%d", *, pattern: re.Pattern | None = None) -> List[GitTag]:

noirbizarre · 2024-03-04T20:35:18Z

tests/test_tags.py

+
+from commitizen.tags import make_tag_pattern, tag_from_version
+
+TAG_FORMATS: Dict[str, Dict[str, list]] = {


As a failsafe, add a case for the minimal $version that should always work:

Suggested change

TAG_FORMATS: Dict[str, Dict[str, list]] = {

TAG_FORMATS: Dict[str, Dict[str, list]] = {

"$version": {

"tags_per_version": [

("1.2.3", "1.2.3"),

("1.2.3a2", "1.2.3a2"),

("1.2.3b2", "1.2.3b2"),

("1.2.3+1.0.0", "1.2.3+1.0.0"),

],

"invalid_tags": ["v1.2.3", "unknown-tag", "1-2-3", "ver1.0.0"]

},

AlexeySanko · 2024-05-24T16:47:46Z

Looks as great feature for monorepo. Any update on it?

robertschweizer added 6 commits May 2, 2023 18:21

refactor: Make tag_format properly default to $version

c26e5bd

We've been using this default already in `normalize_tag`, but setting this value in the settings dict is cleaner.

test: Some cleanup and fix if CWD not project root

0aa98e1

refactor: Move bump.normalize_tag to tags.tag_from_version

10c7a9a

isort fix

c0ff3af

test: Clean up path fixtures

c780f4e

config_path and changelog_path rely on the modified CWD provided by tmp_commitizen_project, so they should use this fixture.

feat: Introduce tag_regex option with smart default

e58e56f

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 force-pushed the filter-tags branch from 8eea9ea to e58e56f Compare May 2, 2023 16:49

Lee-W reviewed Jun 23, 2023

View reviewed changes

Lee-W added the pr-status: wait-for-modification label Jun 23, 2023

robertschweizer mentioned this pull request Jun 27, 2023

Document tag_format and centrally set default value #775

Merged

4 tasks

Lee-W added the help wanted label Aug 20, 2023

saivenky mentioned this pull request Sep 14, 2023

Tag name validation issue on cz bump --changelog #845

Open

noirbizarre reviewed Mar 4, 2024

View reviewed changes

Lowaiz mentioned this pull request Mar 28, 2024

fix(changelog): handle custom tag_format in changelog generation #995

Open

4 tasks

AlexeySanko mentioned this pull request May 24, 2024

Add support for scoped changelog generation: cz changelog --scope myscope #530

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Introduce tag_regex option with smart default #692

feat: Introduce tag_regex option with smart default #692

robertschweizer commented Mar 23, 2023

codecov bot commented Mar 23, 2023 •

edited

robertschweizer commented May 3, 2023

Lee-W Jun 23, 2023

Lee-W Jun 23, 2023

Lee-W commented Jun 23, 2023

robertschweizer commented Jun 27, 2023

woile commented Sep 14, 2023

noirbizarre left a comment

noirbizarre Mar 4, 2024

noirbizarre Mar 4, 2024

noirbizarre Mar 4, 2024

noirbizarre Mar 4, 2024

noirbizarre Mar 4, 2024

AlexeySanko commented May 24, 2024

	Default: Based on `tag_format`
	Default: Computed from `tag_format`

	Default: Based on `tag_format`
	Default: Extrapolated from `tag_format`

	def get_tags(dateformat: str = "%Y-%m-%d", *, pattern: re.Pattern) -> List[GitTag]:
	def get_tags(dateformat: str = "%Y-%m-%d", *, pattern: re.Pattern \| None = None) -> List[GitTag]:


		from commitizen.tags import make_tag_pattern, tag_from_version

		TAG_FORMATS: Dict[str, Dict[str, list]] = {

-TAG_FORMATS: Dict[str, Dict[str, list]] = {
+TAG_FORMATS: Dict[str, Dict[str, list]] = {
+	"$version": {
+		"tags_per_version": [
+			("1.2.3", "1.2.3"),
+            ("1.2.3a2", "1.2.3a2"),
+            ("1.2.3b2", "1.2.3b2"),
+            ("1.2.3+1.0.0", "1.2.3+1.0.0"),
+		],
+		"invalid_tags": ["v1.2.3", "unknown-tag", "1-2-3", "ver1.0.0"]
+	},

feat: Introduce tag_regex option with smart default #692

Are you sure you want to change the base?

feat: Introduce tag_regex option with smart default #692

Conversation

robertschweizer commented Mar 23, 2023

Description

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

codecov bot commented Mar 23, 2023 • edited

Codecov Report

robertschweizer commented May 3, 2023

Lee-W Jun 23, 2023

Choose a reason for hiding this comment

Lee-W Jun 23, 2023

Choose a reason for hiding this comment

Lee-W commented Jun 23, 2023

robertschweizer commented Jun 27, 2023

woile commented Sep 14, 2023

noirbizarre left a comment

Choose a reason for hiding this comment

noirbizarre Mar 4, 2024

Choose a reason for hiding this comment

noirbizarre Mar 4, 2024

Choose a reason for hiding this comment

noirbizarre Mar 4, 2024

Choose a reason for hiding this comment

noirbizarre Mar 4, 2024

Choose a reason for hiding this comment

noirbizarre Mar 4, 2024

Choose a reason for hiding this comment

AlexeySanko commented May 24, 2024

codecov bot commented Mar 23, 2023 •

edited