che-incubator / dash-licenses

Container wrapper for Eclipse Dash License Tool

This is a container wrapper for The Eclipse Dash License Tool that allows easily to generate dependencies files with container image without the need to compile dash-licenses jar. It supports the following package managers:

• mvn
• npm
• yarn

Requirements

• Docker

Build

scripts/build.sh

Usage

Update dependency info

The following command generates dependencies info of a project and then checks all found dependencies. It returns a non-zero exit code if any of them are restricted to use.

docker run --rm -t \
       -v ${PWD}/:/workspace/project  \
       quay.io/che-incubator/dash-licenses:next

As the result this command creates next files:

• prod.md with the list of production dependencies;
• dev.md which contains only build and test dependencies;
• problems.md will be created if some dependencies are not covered with CQ, unnecessary excludes present, etc.

Check dependencies

If you just need to verify that all dependencies satisfy IP requirements, use the --check flag, like the following

docker run --rm -t \
       -v ${PWD}/:/workspace/project  \
       quay.io/che-incubator/dash-licenses:next --check

So, this command doesn't create any new files in the project directory (except a temporary one) but checks if the dependencies info is up-to-date and then validates all found dependencies. It returns a non-zero exit code if any of the dependencies are restricted to use.

Debug

If you need all the generated files including logs and intermediate, use --debug flag:

docker run --rm -t \
       -v ${PWD}/:/workspace/project  \
       quay.io/che-incubator/dash-licenses:next --debug

This command copies all files from the temporary directory. It returns a non-zero exit code if any of the dependencies are restricted to use.