Skip to content

Conversation

swinslow
Copy link
Member

@swinslow swinslow commented Jun 28, 2025

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]

Copy link
Collaborator

@xsuchy xsuchy left a 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.

@swinslow swinslow changed the title [WIP - Do not merge] Change to JSON-formatted expected warnings Change to JSON-formatted expected warnings Jul 1, 2025
@swinslow
Copy link
Member Author

swinslow commented Jul 1, 2025

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.

@swinslow swinslow marked this pull request as ready for review July 1, 2025 15:36
Copy link
Member

@goneall goneall left a 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 @@
[
Copy link
Member

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": []
}

@goneall
Copy link
Member

goneall commented Aug 17, 2025

@swinslow
Just a reminder - once this is updated to the new structure consistent with spdx/LicenseListPublisher#216, I can merge in the changes to to the publisher.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants