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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jappja
Copy link

@jappja jappja commented May 15, 2025

Description

This PR adds missing "--tag-format" argument to cz changelog command, similar to cz bump command.
The changelog command implementation already checks "tag_format" argument but cli support was just missing.

Checklist

  • Add test cases to all the changes you introduce
  • Run poetry all 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

Tag format can be given as argument to cz changelog command. The changelog command already checks "tag_format" argument:

args.get("tag_format") or self.config.settings["tag_format"]

Steps to Test This Pull Request

Additional context

Changelog command already checks "tag_format" argument but cli support was missing.
Copy link

codecov bot commented May 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.57%. Comparing base (120d514) to head (eb45ef5).
Report is 606 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1414      +/-   ##
==========================================
+ Coverage   97.33%   97.57%   +0.23%     
==========================================
  Files          42       57      +15     
  Lines        2104     2680     +576     
==========================================
+ Hits         2048     2615     +567     
- Misses         56       65       +9     
Flag Coverage Δ
unittests 97.57% <ø> (+0.23%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jappja jappja marked this pull request as ready for review May 15, 2025 09:56
Copy link
Member

@noirbizarre noirbizarre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked and the changelog command is actually already handling it but it was missing 👍🏼
Thanks !

@Lee-W
Copy link
Member

Lee-W commented May 15, 2025

let's wait for other doc changes and then merge this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants