Validate dependencies licenses #836
Merged
Conversation
This file contains 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
|
|
daniel-shuy
force-pushed
the
feature/validate-dependencies-licenses
branch
from
a222016
to
de80b2a
Compare
Codecov Report
@@ Coverage Diff @@
## master #836 +/- ##
==========================================
- Coverage 42.89% 42.84% -0.06%
==========================================
Files 135 135
Lines 10574 10574
==========================================
- Hits 4536 4530 -6
- Misses 5448 5451 +3
- Partials 590 593 +3
Continue to review full report at Codecov.
|
arielshaqed
reviewed
Oct 19, 2020
There was a problem hiding this comment.
Thanks, @daniel-shuy ! This would be a nice safety net for us.
I'll ask @ozkatz to have a look at it, it does make sense but we need to know we're checking for the right things.
| check-licenses-npm: | ||
| go get github.com/senseyeio/diligent/cmd/diligent | ||
| # The -i arg is a workaround to ignore NPM scoped packages until https://github.com/senseyeio/diligent/issues/77 is fixed | ||
| $(GOBINPATH)/diligent check -w permissive -i ^@[^/]+?/[^/]+ $(UI_DIR) |
There was a problem hiding this comment.
|
|
||
| check-licenses-go-mod: | ||
| go get github.com/google/go-licenses | ||
| $(GOBINPATH)/go-licenses check ./cmd/$(LAKEFS_BINARY_NAME) |
There was a problem hiding this comment.
@ozkatz here we could also add a check category, I guess.
ozkatz
approved these changes
Oct 20, 2020
|
Thanks! |
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.
Closes #449
This PR adds
Makefiletasks to validatego-modandnpmdependency licenses to ensure they are compatible with the project's license (Apache-2.0).I used go-licenses for validating
go-moddependencies, and diligent for validatingnpmdependencies.Currently, I have only added the tasks to the
Makefile, but I haven't added them to the GitHub Actions workflow file(s). Which workflow should I bind it to?Ideally I would've liked to use diligent for both
go-modandnpmdependencies, as it claims to be able to do so, but unfortunately I couldn't get it to work withgo-mod.Since I couldn't use a single tool for both
go-modandnpm, I could've used a different tool for validatingnpmdependencies, however I couldn't find another one than diligent that allowed specifying the license type (eg.permissive). diligent also has the advantage of being a Go module.Also, I had to update
base-64to1.0.0because it had the license information in the wrong place, which was causing diligent to detect it aslicense: none(see mathiasbynens/base64#24).Also, note that there is an issue with diligent that prevents it from working with NPM scoped packages (eg.
@primer/octicons-react). I have created an issue for this (senseyeio/diligent/issues/77). As a workaround, I have configured diligent to ignore scoped packages.Note that go-licenses ignores Go modules without any license (or modules that it fails to detect a license for), whereas diligent will fail validation if it cannot find an NPM package or a license for an NPM package (which is why the workaround above to ignore scoped packages is required).
Example
make check-licenses-go-modoutput (this is considered passing despite all the warnings):Example
check-licenses-npmoutput: