X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-maven-jobs.rst;h=c9208a18b3dc51ca54b2ddb8811e52fcbb6dd2b5;hb=03a8000420795c1275e9496b0dce978dabad01c4;hp=411a712642ad7d8838421268e314c0cf267fe64e;hpb=cc281dac5f29fec045c7332094d55faa98acd924;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst index 411a7126..c9208a18 100644 --- a/docs/jjb/lf-maven-jobs.rst +++ b/docs/jjb/lf-maven-jobs.rst @@ -39,7 +39,6 @@ Runs Sonar against a Maven project and pushes results to SonarCloud. :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. (default: openjdk11) :sonarcloud-qualitygate-wait: SonarCloud flag that forces the analysis step to wait for the quality gate result. (default: false) @@ -322,6 +321,8 @@ This job uses the following strategy to deploy jobs to Nexus: :mvn-params: Parameters to pass to the mvn CLI. (default: '') :mvn-version: Version of maven to use. (default: mvn35) :nexus-cut-dirs: Number of directories to cut from file path for `wget -r`. + :pre-build-script: Shell script to run before maven build. (default: a string with a shell comment) + :post-build-script: Shell script to run after maven build. (default: a string with a shell comment) :stream: Keyword that represents a release code-name. Often the same as the branch. (default: master) :submodule-recursive: Whether to checkout submodules recursively. @@ -419,6 +420,8 @@ directory is then used later to deploy to Nexus. (default: false) :sbom-generator-version: SBOM generator version to download and run if using sbom-generator. (default: v0.0.10) + :sbom-path: Path where SBOM is going to be executed from. + (default: $WORKSPACE) :sign-artifacts: Sign artifacts with Sigul. (default: false) :stream: Keyword that represents a release code-name. Often the same as the branch. (default: master) @@ -522,7 +525,9 @@ multi-branch configuration. :sonarcloud-project-key: SonarCloud project key. (default: '') :sonarcloud-project-organization: SonarCloud project organization. (default: '') - :sonarcloud-api-token: SonarCloud API Token. (default: '') + :sonarcloud-api-token-cred-id: Jenkins credential ID which has the SonarCloud API Token. + This one SHOULDN'T be overwritten as per we are standarizing the credential ID for all + projects (default: 'sonarcloud-api-token') :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) @@ -576,6 +581,8 @@ This job runs on dev branches and its triggered on new patchsets. :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '') :mvn-params: Parameters to pass to the mvn CLI. (default: '') :mvn-version: Version of maven to use. (default: mvn35) + :pre-build-script: Shell script to run before maven build. (default: a string with a shell comment) + :post-build-script: Shell script to run after maven build. (default: a string with a shell comment) :sonar-mvn-goal: Maven goals to run for sonar analysis. (default: sonar:sonar) :sonarcloud: Set to ``true`` to use SonarCloud ``true|false``. @@ -583,7 +590,9 @@ This job runs on dev branches and its triggered on new patchsets. :sonarcloud-project-key: SonarCloud project key. (default: '') :sonarcloud-project-organization: SonarCloud project organization. (default: '') - :sonarcloud-api-token: SonarCloud API Token. (default: '') + :sonarcloud-api-token-cred-id: Jenkins credential ID which has the SonarCloud API Token. + This one SHOULDN'T be overwritten as per we are standarizing the credential ID for all + projects (default: 'sonarcloud-api-token') :sonarcloud-java-version: Version of Java to use for the Sonar scan. (default: openjdk11) :sonarcloud-qualitygate-wait: SonarCloud flag that forces the analysis step to wait for the quality gate result. (default: false)