Skip to content

Commit 58a4e96

Browse files
committed
Readme updates to add instruction on how to skip certain static analysis plugins that run by default.
1 parent 7bb7116 commit 58a4e96

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,25 @@ Yoti also allows you to enable user details verification from your mobile app by
6060

6161
## Building From Source
6262

63-
Building from source is generally not necessary since artifacts are published in Maven Central. However, if you want to build from source you can do so using the [Maven Wrapper](https://github.com/takari/maven-wrapper) that is bundled with this distribution. For those familiar with Gradle this is much like the Gradle Wrapper and ensures that the correct version of Maven is being used.
63+
Building from source is generally not necessary for third parties since artifacts are published in Maven Central. However, if you want to build from source you can do so using the [Maven Wrapper](https://github.com/takari/maven-wrapper) that is bundled with this distribution. For those familiar with Gradle this is much like the Gradle Wrapper and ensures that the correct version of Maven is being used.
6464

6565
From the top level directory:
6666

6767
```bash
6868
./mvnw clean install
6969
```
7070

71+
Notable flags that you may wish to use to skip certain static analysis/code quality tools are listed below. This is only recommended if you find that there tools are taking too long during development or are raising false positives that you are yet to exclude. **They should not be ignored when building a candidate for a release.**
72+
73+
* `-Dfindbugs.skip=true`: skips findbugs and the findbugs security extension.
74+
* `-Ddependency-check.skip=true`: skips the OWASP dependency scanner.
75+
76+
### Example usage
77+
78+
```bash
79+
./mvnw clean install -Dfindbugs.skip=true -Ddependency-check.skip=true
80+
```
81+
7182
## Enabling the SDK
7283

7384
To import the Yoti SDK inside your project, you can use your favourite dependency management system.

0 commit comments

Comments
 (0)