Update License metadata#217
Draft
nickswalker wants to merge 6 commits intorobot-descriptions:mainfrom
Draft
Conversation
Add test to require new additions to be in correct order
Generate README from registry, to avoid typos, sorting errors, drift... Generate license URL from repo URL
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Meant to be considered after #216
I realized that some of the descriptions I added were under the wrong license. Specifically, some of the newer UR models have a permissive but non-standard license. #203
This sort of detail can be difficult to catch on manual inspection, so I am proposing that license metadata be incorporated into the description registry itself, so that 1) the pointed-to license file's existence can be enforced and 2) it is easier to incorporate an automated checker in the future.
Putting this data in the registry means the readme tables can be synthesized from the registry, avoiding sorting errors and typos. Some of my additions introduced these errrors. It also let's us directly surface a link to the pointed-to LICENSE file, so consumers can more easily verify.