Skip to content

feat(cli): add --tag-format argument to changelog command #1414

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 20, 2025
Merged

feat(cli): add --tag-format argument to changelog command #1414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions commitizen/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,10 @@ def __call__(
"help": "Export the changelog template into this file instead of rendering it",
},
*deepcopy(tpl_arguments),
{
"name": "--tag-format",
"help": "The format of the tag, wrap around simple quotes",
},
],
},
{
Expand Down
4 changes: 3 additions & 1 deletion .../test_changelog_command/test_changelog_command_shows_description_when_use_help_option.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME]
[--start-rev START_REV] [--merge-prerelease]
[--version-scheme {pep440,semver,semver2}]
[--export-template EXPORT_TEMPLATE] [--template TEMPLATE]
[--extra EXTRA]
[--extra EXTRA] [--tag-format TAG_FORMAT]
[rev_range]

generate changelog (note that it will overwrite existing file)
Expand Down Expand Up @@ -37,3 +37,5 @@ options:
changelog template file name (relative to the current
working directory)
--extra, -e EXTRA a changelog extra variable (in the form 'key=value')
--tag-format TAG_FORMAT
The format of the tag, wrap around simple quotes