feat: add include and exclude path to the config#1173
Merged
orhun merged 6 commits intoorhun:mainfrom Jun 22, 2025
Kriskras99:feat/include_and_exclude_path_in_config
Merged
feat: add include and exclude path to the config#1173orhun merged 6 commits intoorhun:mainfrom Kriskras99:feat/include_and_exclude_path_in_config
orhun merged 6 commits intoorhun:mainfrom
Kriskras99:feat/include_and_exclude_path_in_config
Conversation
|
Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️ |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1173 +/- ##
==========================================
- Coverage 42.35% 41.87% -0.47%
==========================================
Files 21 21
Lines 1991 2011 +20
==========================================
- Hits 843 842 -1
- Misses 1148 1169 +21
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! ⛰️ |
1 task
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the option of setting
include_pathandexclude_pathin the config file.Motivation and Context
Closes #1168.
This is useful if you have tools calling git-cliff (like release-plz) that don't give the ability
to set command line arguments.
How Has This Been Tested?
Testing
exclude_pathgit-cliff | wc -land note the amount of linesgit-cliff --exclude-path git-cliff-core/ | wc -land note the amount of linesexclude-paths = ["git-cliff-core/"]git-cliff | wc -land note the amount of linesThe output of step 4 should equal the output of step 2 and not equal the output of step 1
Testing
include_pathgit-cliff | wc -land note the amount of linesgit-cliff --include-path git-cliff/ --include-path git-cliff-core/ | wc -land note the amount of linesinclude_paths = ["git-cliff/", "git-cliff-core/"]git-cliff | wc -land note the amount of linesThe output of step 4 should equal the output of step 2 and not equal the output of step 1
Both tests were run in the root of the git-cliff repository on a Linux machine.
I could not figure out how to mock commits with changed files and thus have not written any unit/integration tests.
Types of Changes
Checklist: