git-cliff
git-cliff copied to clipboard
feat: add option git.require-grouped
Description
Adds a new option git.require-grouped. When this option is set to true, all commits contained within the changelog must be assigned to a group via CommitParser. If any ungrouped commit is found, an error is logged and changelog generation fails.
The check happens after running the CommitParsers. Thus it is still possible to intentionally skip commits.
Motivation and Context
Just like #1061, this option aids in enforcing contribution guidelines by preventing the use of unsupported groups or scopes.
How Has This Been Tested?
Screenshots / Logs (if applicable)
Types of Changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation (no code change)
- [ ] Refactor (refactoring production code)
- [ ] Other
Checklist:
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 41.41%. Comparing base (
bf50336) to head (e46121e).
Additional details and impacted files
@@ Coverage Diff @@
## main #1088 +/- ##
==========================================
- Coverage 41.42% 41.41% -0.01%
==========================================
Files 21 21
Lines 1811 1814 +3
==========================================
+ Hits 750 751 +1
- Misses 1061 1063 +2
| Flag | Coverage Δ | |
|---|---|---|
| unit-tests | 41.41% <100.00%> (-0.01%) |
:arrow_down: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: 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.
- 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
Hey @Cyclonit, what's the progress with this one? 👀 still interested in finishing the implementation?
Hey @Cyclonit, what's the progress with this one? 👀 still interested in finishing the implementation?
Hi, yes definitely. Just didn't get around it. I think it is an important feature to have git-cliff serve a vital role in "corporate-level" pipelines.
Yup, definitely agree!
Still interest or any updates on this?