feat: allow explicitly ignoring the license of a package in config #1243
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
G-Rath
force-pushed
the
config/license-ignore
branch
from
59929c6 to
79cc657
Compare
G-Rath
force-pushed
the
config/license-ignore
branch
from
79cc657 to
5d8ae74
Compare
G-Rath
commented
Sep 11, 2024
cmd/osv-scanner/fixtures/osv-scanner-complex-licenses-config.toml
Outdated
Show resolved
Hide resolved
G-Rath
commented
Sep 11, 2024
docs/configuration.md
Outdated
Comment on lines
45
to
47
| ignore = true # Ignore this package completely, including license scanning | ||
| license.ignore = true # Ignore the license of the package, if it is not already completely ignored at the top level | ||
| license.override = ["MIT", "0BSD"] # Override the license of the package, if it is not completely ignored at the top level |
There was a problem hiding this comment.
note: I've purposely kept the documentation here light as I think it'll be easier to document once #1226 is landed
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1243 +/- ##
==========================================
- Coverage 67.83% 67.82% -0.02%
==========================================
Files 174 174
Lines 16769 16773 +4
==========================================
+ Hits 11375 11376 +1
- Misses 4765 4767 +2
- Partials 629 630 +1 ☔ View full report in Codecov by Sentry. |
|
@G-Rath I am a bit confused about what this PR does - could you update the description with more details? |
|
@cuixq I've added a short description, though I think the linked issue gives context too - let me know if there's anything specific you're still confused on that you'd like me to clarify |
cuixq
reviewed
Sep 12, 2024
cmd/osv-scanner/fixtures/osv-scanner-complex-licenses-config.toml
Outdated
Show resolved
Hide resolved
cuixq
approved these changes
Sep 13, 2024
another-rex
reviewed
Sep 13, 2024
docs/configuration.md
Outdated
| license.override = ["MIT", "0BSD"] # Override the license of the package, if it is not ignored | ||
| ignore = true # Ignore this package completely, including license scanning | ||
| license.ignore = true # Ignore the license of the package, if it is not already completely ignored at the top level | ||
| license.override = ["MIT", "0BSD"] # Override the license of the package, if it is not completely ignored at the top level |
There was a problem hiding this comment.
Suggested change
| license.override = ["MIT", "0BSD"] # Override the license of the package, if it is not completely ignored at the top level | |
| license.override = ["MIT", "0BSD"] # Override the license of the package, if it is not completely ignored |
I think this should be updated now that ignore takes priority.
another-rex
approved these changes
Sep 13, 2024
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 allows you to configure the scanner to completely ignore the license of a package in a way that is explicit, as oppose to configuring
license.overridesto set the package license to an allowed one.Resolves #1124