-
Notifications
You must be signed in to change notification settings - Fork 342
Change to JSON-formatted expected warnings #2772
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Steve Winslow <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OMG, this is much better. Thank you.
Thanks @xsuchy! @goneall, when you have a minute to take a look at this as well as the related changes to the publisher at spdx/LicenseListPublisher#216, I'd welcome your thoughts in particular. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change to support possible future warnings in the license list publisher.
@@ -0,0 +1,19 @@ | |||
[ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the functionality of the "ignore warnings" is to ignore all warnings, not just duplicate licenses (even if that is the only warnings being generated currently), suggest we change this from a JSON array to a JSON object with 2 properties:
duplicates
additionalWarnings
both would be arrays.
e.g.:
{
"duplicates" : [ ["AGPL ...], ...],
"additionalWarnings": []
}
@swinslow |
This is a draft PR for changing to a JSON-formatted version of the
expected-warnings
file. This corresponds to the related PR at spdx/LicenseListPublisher#216.This should not be merged until after the 3.27.0 release is completed (which should be within the next 1-2 days, for real this time...)3.27.0 is now released, so let's see how we feel about moving this one forward!The new
expected-warnings.json
file is formatted as an array of arrays of strings. Each array of strings is a list of license IDs that should together be treated as ignored warnings, if they are interpreted as being duplicates during the parsing and license list publishing process. (The specifics of how the publisher can work with this are described in the PR at spdx/LicenseListPublisher#216.)This should be much easier to maintain than the existing list of "Duplicates licenses:" strings. Open to thoughts on the format or any other considerations / concerns.
Signed-off-by: Steve Winslow [email protected]