Documenting false_secrets in pubspec.yaml
#3409
Merged
Conversation
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
google-cla
bot
added
the
cla: yes
jonasfj
commented
Jul 21, 2021
The short-link `https://dart.dev/go/false-leaks` is used in the `pub` client error messages as a means to explain how _false positives_ found by leak detection can be ignored.
jonasfj
changed the title
false_leaks in pubspec.yamlfalse_secrets in pubspec.yaml
sigurdm
reviewed
Aug 31, 2021
kwalrath
added
the
st.blocked
kwalrath
reviewed
Dec 7, 2021
Contributor
|
This page had some changes, so I staged the merged version (a clean merge). |
Member
Author
Yeah, this looks great :D |
mit-mit
reviewed
Dec 8, 2021
| Leak detection isn't perfect. | ||
| To avoid false positives, | ||
| you can tell pub not to search for leaks in certain files, | ||
| using [`gitignore` patterns][] under |
Member
There was a problem hiding this comment.
I suggest changing:
"you can tell pub not to search for leaks in certain files,
using [gitignore patterns][]"
To:
"you can tell pub not to search for leaks in certain files,
by creating an allowlist
using [gitignore patterns][]"
Member
There was a problem hiding this comment.
I'll send a separate PR for that potential change
mit-mit
removed
the
st.blocked
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Implementation on
pubclient: dart-lang/pub#3049.Many of the patterns and heuristics for detection of leaks are adopted from How Bad Can It Git? and awslabs/git-secrets.
We could perhaps consider mentioning these in the documentation, to help people better understand what kind of heuristics is employed for leak detection.
This won't ship until Dart 2.15, I'm not planning to sneak in new features right before the window closes.