include prohibited regular expressions from a .gitprohibited file #163
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
…gitprohibited file
|
Would love to see this merged in! |
sparr
suggested changes
Jun 21, 2023
There was a problem hiding this comment.
Tests are also needed for this change.
- positive test, prohibited pattern is successfully detected as a secrets match
- negative test, commented line doesn't match
- positive test, line starting with
(#)(or another suggested alternative to^#) matches
Possibly others, try to exercise the various use cases here.
| @@ -403,6 +403,9 @@ like Ubuntu (BSD vs GNU). | |||
| You can add prohibited regular expression patterns to your git config using | |||
| ``git secrets --add <pattern>``. | |||
|
|
|||
| You can also add prohibited regular expressions patterns to a | |||
| ``.gitprohibited`` file located in the repository's root directory. Lines starting | |||
| with ``#`` are skipped (comment line) and empty lines are also skipped. | |||
There was a problem hiding this comment.
I'm not sold on the name, but can't think of a better one. I'm opening this thread to explicitly ask the next reviewer to weigh in on the file name.
| @@ -47,6 +47,10 @@ prepare_commit_msg_hook* prepare-commit-msg hook (internal only)" | |||
|
|
|||
| load_patterns() { | |||
| git config --get-all secrets.patterns | |||
| local gitprohibited="$(git rev-parse --show-toplevel)/.gitprohibited" | |||
| if [ -e "$gitprohibited" ]; then | |||
| cat $gitprohibited | awk 'NF && $1!~/^#/' | |||
There was a problem hiding this comment.
Suggested change
| cat $gitprohibited | awk 'NF && $1!~/^#/' | |
| awk 'NF && $1!~/^#/' "$gitprohibited" |
cat is not necessary here, and the quotes are needed in case the path to the file has spaces
| @@ -403,6 +403,9 @@ like Ubuntu (BSD vs GNU). | |||
| You can add prohibited regular expression patterns to your git config using | |||
| ``git secrets --add <pattern>``. | |||
|
|
|||
| You can also add prohibited regular expressions patterns to a | |||
| ``.gitprohibited`` file located in the repository's root directory. Lines starting | |||
| with ``#`` are skipped (comment line) and empty lines are also skipped. | |||
There was a problem hiding this comment.
How should the user specify patterns that start with #? I think (#) would work, but that should probably be explicitly described here.
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.
Update git-secrets to include prohibited regular expressions from a .gitprohibited file
Issue #, if available:
Add the possibility of using a
.gitprohibitedfile in the repository root to include prohibited patterns - much the same as.gitallowedis used to mark false positivesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.