Skip to content

Commit

Permalink
Add documentation on checking vulnerabilities and allowed licences
Browse files Browse the repository at this point in the history
  • Loading branch information
janblom committed Nov 13, 2024
1 parent 5a62ccb commit edcfec3
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,19 @@ When adding test, please follow these conventions:
Also, GitHub actions have been configured to run the test suite automatically on Github for branches
that have been configured for this (typically the master branch, and pull requests to the master branch).

##### Checking for potential vulnerabilities

The project uses the OWASP dependency-check plugin to check for potential vulnerabilities in the dependencies. Because this
check can take a long time (for downloading/updating the vulnerabilities database), it is disabled by default,
but can be enabled by running `mvn dependency-check:check`.

##### Checking for compatible licenses

Since the Rabbit tools are open source, it is important that the dependencies are also open source.
The verification phase ('mvn verify') will also check for compatible licenses in the dependencies. This is done by the maven-license-plugin.
When dependencies are updated, sometimes the license changes, and this can cause the verification build to fail. In that case, one can extend the
list of allowed licenses in the `pom.xml` file.

### Example in- and output

The file `examples.zip` contains a set of input and output examples for White Rabbit and Rabbit in a Hat.
Expand Down

0 comments on commit edcfec3

Please sign in to comment.