refactor: renamed property for skipping the CVE check and update read…

…me accordingly
SAP · May 3, 2024 · afaffdc · afaffdc
1 parent b59139a
commit afaffdc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,14 @@ Foundry and Kubernetes (K8S) environment.
 Building the project is as simple as running the following command:
 
 ```sh
-mvn clean install
+mvn clean install -Dgpg.skip -DskipCveCheck
+```
+
+The command above skips both signing the artifacts and performing vulnerability checks.
+If you like to run the vulnerability checks (which might take a while, as it downloads the CVE database), you may use the following command instead:
+
+```sh
+mvn clean install -Dgpg.skip -DupdateCveDatabase
 ```
 
 ## Usage

diff --git a/pom.xml b/pom.xml
@@ -54,7 +54,7 @@
  <java.version>1.8</java.version>
  <maven.version>3.8</maven.version>
  <java.failOnWarning>true</java.failOnWarning>
- <skipTests>false</skipTests>
+ <skipCveCheck>false</skipCveCheck>
  <updateCveDatabase>false</updateCveDatabase>
  <project.rootdir>${project.basedir}</project.rootdir>
  <project.build.resourceEncoding>UTF-8</project.build.resourceEncoding>
@@ -246,7 +246,7 @@
  </execution>
  </executions>
  <configuration>
- <skip>${skipTests}</skip>
+ <skip>${skipCveCheck}</skip>
  <skipProvidedScope>true</skipProvidedScope>
  <failBuildOnCVSS>7</failBuildOnCVSS>
  <suppressionFile>.etc/suppression.xml</suppressionFile>
@@ -498,4 +498,4 @@
  </build>
  </profile>
  </profiles>
-</project>
+</project>