Initial contribution of dash-licenses-wrapper #1
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.
Description
This contribution provides a wrapper, to make it easier to integrate and run dash-licenses, in Eclipse Foundation projects repositories. It's mainly aiming to cover JavaScript and TypeScript projects, but might be usable in others too.
Once published to
npm
, the wrapper can be installed as a devDependency and used to run license checks locally on a developer's laptop and also as part of GitHub CI, using a provided exampleworkflow
file.See README.md for more details
Testing
This contribution includes some minimal tests, run from a
CI Tests
GitHub workflow. There is a second3PP License Check
workflow that uses a trick to install the wrapper as a pseudo npm package and then run a license check, which gives a preview of what it will look-like when integrated to other projects/repos. Until this is published tonpm
, a similar trick could be used to install it temporarily, for a quick check.I created a test PR on my fork so they would run. See the result of the workflow runs below:
CI Tests workflow
3PP License check workflow
Note: An earlier version of this contribution was first proposed as an addition to the dash-licenses repository but since there are no direct dependencies to that repo's content, it was deemed better to have it in on its own.