fix: Remove any YAML front matter from ScanCode license files #7883
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7883 +/- ##
============================================
+ Coverage 67.06% 67.07% +0.01%
Complexity 2041 2041
============================================
Files 356 356
Lines 17045 17051 +6
Branches 2438 2438
============================================
+ Hits 11431 11437 +6
Misses 4594 4594
Partials 1020 1020
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
sschuberth
force-pushed
the
scancode-yaml-front-matter-removal
branch
from
c2d89f1 to
b0ac800
Compare
fviernau
reviewed
Nov 17, 2023
|
|
||
| licenseLines.joinToString("\n").trim() | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Would it make sense to extract lines 134-144 into a functions e.g. getScanCodeLicenseText(id, dir)
and add a test which calls it for a file which has such YAML in the header, to show it works?
Member
Author
There was a problem hiding this comment.
Done. I've actually improved the algorithm a bit as part of adding the test.
ScanCode 32.0.0 started to prepend its `*.LICENSE` files with YAML-encoded metadata, see [1]. This is a hot fix to remove this header, if present, from the license files. A better solution will be implemented later as part of a larger refactoring of license providers. Different ScanCode versions also differ in whether license files come with a final newline or not. Align on not having a final newline to make tests pass either way. [1]: aboutcode-org/scancode-toolkit#3100 Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
sschuberth
force-pushed
the
scancode-yaml-front-matter-removal
branch
from
b0ac800 to
2000181
Compare
fviernau
approved these changes
Nov 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
ScanCode 32.0.0 started to prepend its
*.LICENSEfiles with YAML-encoded metadata, see 1. This is a hot fix to remove this header, if present, from the license files. A better solution will be implemented later as part of a larger refactoring of license providers.Different ScanCode versions also differ in whether license files come with a final newline or not. Align on not having a final newline to make tests pass either way.