feat: allow filtering commits based on changed paths #25
Conversation
This file contains 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
This branch adds a new `path_filters` field to the `Clog` struct, containing a list of paths in the repository to filter the `git log` invocation. If there are paths in this list, the `git log` command will end with `-- <PATHS...>`, which restricts the list of returned commits to those which modify certain paths in the repo. This is useful for cases where a project contains multiple crates or binaries that should have separate changelogs. See also clog-tool/clog-cli#109 for a related issue. BREAKING CHANGE: This adds a new field to the `Clog` struct. This is not backwards compatible, as adding new fields will break exhaustive pattern matching on that struct. See [the Rust API Guidelines][1] for details. [1]: https://rust-lang.github.io/api-guidelines/future-proofing.html#structs-have-private-fields-c-struct-private
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.
This branch adds a new
path_filtersfield to theClogstruct,containing a list of paths in the repository to filter the
git loginvocation. If there are paths in this list, the
git logcommand willend with
-- <PATHS...>, which restricts the list of returned commitsto those which modify certain paths in the repo.
This is useful for cases where a project contains multiple crates or
binaries that should have separate changelogs. See also
clog-tool/clog-cli#109 for a related issue.
BREAKING CHANGE:
This adds a new field to the
Clogstruct. This is not backwardscompatible, as adding new fields will break exhaustive pattern matching
on that struct. See the Rust API Guidelines for details.