Re-order license entries in index.* files and add the category as property #25
Conversation
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
Re-generating the `docs` by utilizing [1] on my machine running Ubuntu for ScanCode version `31.1.0` produces the same entries for the licenses but differs in terms of their ordering compared to [1]. This is why I assume that the ordering is not deterministic, but somehow dependends on the host system. Sort the license entries by their license key to ensure a deterministic order independent of a host system. This leads to nicer diffs for documentation updates. [1] `make clean build` [2] d29ed2c Signed-off-by: Frank Viernau <frank_viernau@epam.com>
The generation logic has been changed so that license entries in `index.html`, `index.json` and `index.yml` are ordered alphabetically by their (license) key. Re-generate the index files to apply the new order. [1] `make clean build` Signed-off-by: Frank Viernau <frank_viernau@epam.com>
Allow accessing the category without downloading the individual files for each respective license. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
Bring in the property `category` added in a preceeding change. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
AyanSinhaMahapatra approved these changes Sep 28, 2022
There was a problem hiding this comment.
LGTM! Thanks @fviernau .
I'm also adding this to aboutcode-org/scancode-toolkit#3100 (which is in response to aboutcode-org/scancode-toolkit#2738) where the code will eventually belong.
AyanSinhaMahapatra added a commit to aboutcode-org/scancode-toolkit that referenced this pull request Sep 28, 2022
Reference: aboutcode-org/scancode-licensedb#25 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Add
categoryas property so that it can be obtained without examining the individual files for each respective license.See individual commits.