Skip to content
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

Clean up isDeprecated values #1545

Closed
swinslow opened this issue Jul 31, 2022 · 11 comments · Fixed by #1862 or #1864
Closed

Clean up isDeprecated values #1545

swinslow opened this issue Jul 31, 2022 · 11 comments · Fixed by #1862 or #1864
Assignees
Labels
good for new participants easy minor update or fix XML markup change potential change or addition to XML markup in license XML schema change
Milestone

Comments

@swinslow
Copy link
Member

(currently marking for 3.19 docs/cleanup release, but might be more appropriate for 3.20 instead)

This is a follow-on from the discussion in #583. I believe @goneall has reworked the license list publisher tooling to just look for the presence of deprecatedVersion="..." to determine whether or not a license is deprecated. Which means that the separate isDeprecated=true flag is (ironically) deprecated.

Two tasks to do in parallel:

  • remove isDeprecated from the XML schema description file; and
  • go through the deprecated licenses and exceptions to make sure that they have a deprecatedVersion="..." value and to remove the isDeprecated=true flag.
@swinslow swinslow added XML schema change XML markup change potential change or addition to XML markup in license good for new participants easy minor update or fix labels Jul 31, 2022
@swinslow swinslow added this to the 3.19 (documentation) milestone Jul 31, 2022
@swinslow swinslow modified the milestones: 3.19 (documentation), 3.20 Nov 6, 2022
@swinslow
Copy link
Member Author

Moving to 3.21, this is not urgent for 3.20.

Would encourage folks who are new-ish to contributing to the license list to consider helping with this one (since it is good for new contributors, like the tag says). Raise your hand and I'm happy to help advise on what is needed here ;-)

@swinslow swinslow modified the milestones: 3.20, 3.21 Feb 15, 2023
@BassCoder2808
Copy link
Contributor

Hi @swinslow, if the issue is still open, I am happy to contribute to this. Can you please tell me like how should I proceed forward to solve this issue

@swinslow
Copy link
Member Author

swinslow commented Mar 6, 2023

Hello @BassCoder2808,

Yes, this issue is still open. Feel free to review the details above and help would be welcome!

You'll probably want to start by reviewing the comments in this thread and the two bullet points noted in the intro. The second bullet point is the one you'll want to start with, by going through the licenses in the src/ folder and exceptions in the src/exceptions/ folder.

Identify which ones, if any, have a <license> or <exception> tag with an isDeprecated= attribute but without a deprecatedVersion= value.

Once you've identified the licenses and exceptions that meet those criteria, you'll likely want to paste the list of identifiers into a comment here, so that the SPDX legal community can review and help identify which license list release versions correspond to when those identifiers were deprecated.

Then you could use that information to insert the missing deprecatedVersion= values and remove the now-unnecessary isDeprecated= fields. You'd want to submit a PR making those changes, and we can confirm it passes the CI checks and then merge it.

And finally, after that is complete and merged, you could submit a second PR to remove isDeprecated= from the XML schema description file.

Hope this helps!

@BassCoder2808
Copy link
Contributor

Thanks a lot @swinslow for your guidance, now I have got a better idea about how to proceed further, will go through the steps and will let you know if I face any difficulties

@BassCoder2808
Copy link
Contributor

BassCoder2808 commented Mar 6, 2023

@swinslow I think I have completed the first task, like I have found 34 licenses all in the src and src/exceptions folder which contain the isDeprecated field, they have the corresponding deprecatedVersion associated with it in the XML file. I have created a pull request as per your sugession for the part 1 which removes the isDeprecated field from the licenses, please let me know if anything needs to be updated for it.

@swinslow
Copy link
Member Author

swinslow commented Mar 6, 2023

Thank you @BassCoder2808! Just to confirm, are there any licenses or exceptions where isDeprecated is present but deprecatedVersion is not present?

@BassCoder2808
Copy link
Contributor

BassCoder2808 commented Mar 6, 2023

Yes, there are no licenses where isDeprecated is present and the value of deprecatedVersion is not set

@swinslow
Copy link
Member Author

swinslow commented Mar 6, 2023

Great, thank you for the quick work on this! I'll review the PR when I have a chance and will merge it if all looks well.

@BassCoder2808
Copy link
Contributor

Hi @swinslow , as the first part has been merged, should I remove the isDeprecated attribute from the XML Schema Definition file. Also, I just saw that the documentation file xml-fields.md contains isDeprecated which I think also needs to be removed now, so should I make these 2 changes through a separate issue or through a single PR representing this issue itself

@swinslow swinslow reopened this Mar 7, 2023
@swinslow
Copy link
Member Author

swinslow commented Mar 7, 2023

(re-opening as the schema still needs to be updated)

Hi @BassCoder2808, yes, thank you! You're correct, we'll also want to remove references to it in the documentation. If you can submit a single PR that makes both of those changes (and closes this issue as fixed), that would be perfect. Thank you!

@BassCoder2808
Copy link
Contributor

Hi @swinslow , I have created a new pull request for the same, please review once, and let me know if anything else needs to be changed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good for new participants easy minor update or fix XML markup change potential change or addition to XML markup in license XML schema change
Projects
None yet
2 participants