feat(args): add --skip-tags cli argument#1334
Conversation
Signed-off-by: ooooo <[email protected]>
|
Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️ |
There was a problem hiding this comment.
Pull request overview
This PR adds a new --skip-tags CLI argument to git-cliff, allowing users to skip specific tags matching a regex pattern in the generated changelog. This complements the existing --ignore-tags functionality.
Key Changes:
- Added new
skip_tagsCLI argument with environment variable support - Integrated the argument into the configuration processing logic
- Added comprehensive test fixtures to validate the functionality
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
git-cliff/src/args.rs |
Defines the new skip_tags CLI argument with proper clap attributes |
git-cliff/src/lib.rs |
Processes the skip_tags argument and updates the configuration |
website/docs/usage/args.md |
Documents the new CLI argument (contains naming inconsistency) |
website/docs/configuration/git.md |
Documents the configuration override (contains naming inconsistency) |
.github/workflows/test-fixtures.yml |
Adds test case for the new argument |
.github/fixtures/test-cli-arg-skip-tags/expected.md |
Expected output for the test fixture |
.github/fixtures/test-cli-arg-skip-tags/commit.sh |
Test setup script creating commits and tags |
.github/fixtures/test-cli-arg-skip-tags/cliff.toml |
Configuration file for the test fixture |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1334 +/- ##
==========================================
- Coverage 43.48% 43.40% -0.08%
==========================================
Files 23 23
Lines 2245 2247 +2
==========================================
- Hits 976 975 -1
- Misses 1269 1272 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Congrats on merging your first pull request! ⛰️ |
Description
Adds --skip-tags argument to cli.Motivation and Context
fixes #1313
How Has This Been Tested?
Add a new fixture in
.github/fixtures/test-cli-arg-skip-tagsaccording to.github/fixtures/README.md.Screenshots / Logs (if applicable)
Types of Changes
Checklist: