Add sonar-prescan-script jobs for maven

[releng/global-jjb.git] / docs / jjb / lf-maven-jobs.rst

diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst
index 3b3676c..d312cec 100644 (file)
--- a/docs/jjb/lf-maven-jobs.rst
+++ b/docs/jjb/lf-maven-jobs.rst
@@ -34,12 +34,13 @@ Runs Sonar against a Maven project and pushes results to SonarCloud.
 
 :Required Parameters:
 
-    :java-version: Version of Java to execute Sonar with.
+    :java-version: Version of Java to execute Maven build. (default: openjdk8)
     :mvn-version: Version of Maven to execute Sonar with.
     :mvn-settings: Maven settings.xml file containing credentials to use.
     :sonarcloud-project-key: SonarCloud project key.
     :sonarcloud-project-organization: SonarCloud project organization.
     :sonarcloud-api-token: SonarCloud API Token.
+    :sonarcloud-java-version: Version of Java to run the Sonar scan.
 
 lf-maven-build
 --------------
@@ -466,6 +467,9 @@ multi-branch configuration.
     - {project-name}-sonar
     - gerrit-maven-sonar
     - github-maven-sonar
+    - {project-name}-sonar-prescan-script
+    - gerrit-maven-sonar-prescan-script
+    - github-maven-sonar-prescan-script
 
 :Comment Trigger: run-sonar
 
@@ -474,6 +478,8 @@ multi-branch configuration.
     :build-node: The node to run build on.
     :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
     :mvn-settings: The name of settings file containing credentials for the project.
+    :sonar-prescan-script: (maven-sonar-prescan-script jobs) A shell script to run before
+        sonar scans.
 
 :Optional parameters:
 
@@ -484,7 +490,7 @@ multi-branch configuration.
         one may want to provide more than 1 cron timer.  (default: 'H H * * 6'
         to run weekly)
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
-    :java-version: Version of Java to use for the build. (default: openjdk8)
+    :java-version: Version of Java to use for the Maven build. (default: openjdk8)
     :mvn-global-settings: The name of the Maven global settings to use for
         Maven configuration. (default: global-settings)
     :mvn-goals: The maven goals to perform for the build.
@@ -500,6 +506,7 @@ multi-branch configuration.
     :sonarcloud-project-organization: SonarCloud project organization.
         (default: '')
     :sonarcloud-api-token: SonarCloud API Token. (default: '')
+    :sonarcloud-java-version: Version of Java to use for the Sonar scan. (default: openjdk11)
     :stream: Keyword that represents a release code-name.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.