Skip to content

Commit

Permalink
Added documentation about running security scan on the project depend…
Browse files Browse the repository at this point in the history
…encies

Signed-off-by: Alberto Codutti <alberto.codutti@eurotech.com>
  • Loading branch information
Coduz committed Jan 15, 2023
1 parent 2124147 commit 943067f
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/developer-guide/en/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ We use Apache Maven as the build tool of choice.

We use `gitbook` to build the documentation.

## Kapua
## How to build

Kapua is being compiled with Maven.

Expand All @@ -25,6 +25,15 @@ Again, add the `console` profile as well if needed:

mvn clean install -Pdev,console -DskipTests=true

## Security Scan

You can perform the CVE scan of the project by running with the following command:

`mvn verify -DskipTests -Psecurity-scan`

Currently, is configured to run the scan and produce reports but not to fail in case of CVEs detected.
Reports can be found in the `target/security-scan/` directory of each module.

## Documentation

Before you can build documentation, you need to install `gitbook`
Expand Down

0 comments on commit 943067f

Please sign in to comment.