X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-maven-jobs.rst;h=5c786e158f16ff88a5e714d29f9b43cf12a8c8cb;hb=766dbef8a63d824d6e551d4f179806521be95d13;hp=c3ab35b3719b0fc622e5b8777aa97464ff3138e0;hpb=ff3ea7c20d4ea68079502f20efa885b298bc6cb2;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst index c3ab35b3..5c786e15 100644 --- a/docs/jjb/lf-maven-jobs.rst +++ b/docs/jjb/lf-maven-jobs.rst @@ -39,8 +39,7 @@ 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-java-version: Version of Java to run the Sonar scan. (default: openjdk17) :sonarcloud-qualitygate-wait: SonarCloud flag that forces the analysis step to wait for the quality gate result. (default: false) @@ -105,6 +104,16 @@ lf-infra-sonatype-clm Runs a Sonatype CLM scan against a Maven project and pushes results to Nexus IQ server. +:Optional parameters: + :mvn-goals: The maven goals to perform for the build. + (default: clean install) + +lf-infra-snyk-cli-scanner +------------------------- + +Downloads the latest Snyk CLI and triggers a code scan. It publishes a report into +the Snyk dashboard. + :Optional parameters: :mvn-goals: The maven goals to perform for the build. (default: clean install) @@ -171,6 +180,53 @@ Produces a CLM scan of the code into Nexus IQ Server. :gerrit_merge_triggers: Override Gerrit Triggers. +Maven SNYK CLI +-------------- + +Builds the code, downloads and runs a Snyk CLI scan of the code into the Snyk dashboard. + +:Template Names: + + - {project-name}-maven-snyk-cli-{stream} + - gerrit-maven-snyk-cli + - github-maven-snyk-cli + +:Comment Trigger: run-snyk + +:Required parameters: + + :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. + :snyk-token-credential-id: Snyk API token to communicate with Jenkins. + :snyk-org-credential-id: Snyk organization ID. + +:Optional parameters: + + :branch: The branch to build against. (default: master) + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :build-timeout: Timeout in minutes before aborting build. (default: 60) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :java-version: Version of Java to use for the build. (default: openjdk11) + :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. + (default: clean install) + :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) + :snyk-cli-options: Snyk CLI options. (default: '') + :stream: Keyword that represents a release code-name. + Often the same as the branch. (default: master) + :submodule-recursive: Whether to checkout submodules recursively. + (default: true) + :submodule-timeout: Timeout (in minutes) for checkout operation. + (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) + + :gerrit_snyk_triggers: Override Gerrit Triggers. + Maven JavaDoc Publish --------------------- @@ -315,6 +371,8 @@ This job uses the following strategy to deploy jobs to Nexus: one may want to provide more than 1 cron timer. (default: 'H H * * 0' to run weekly) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :jacoco-exclude-pattern: Ant-style patterns to exclude from Jacoco coverage + report. (default: ``"**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"``) :java-version: Version of Java to use for the build. (default: openjdk11) :mvn-global-settings: The name of the Maven global settings to use for Maven configuration. (default: global-settings) @@ -421,7 +479,7 @@ 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. + :sbom-path: SBOM execution path. (default: $WORKSPACE) :sign-artifacts: Sign artifacts with Sigul. (default: false) :stream: Keyword that represents a release code-name. @@ -526,8 +584,10 @@ 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-java-version: Version of Java to use for the Sonar scan. (default: openjdk11) + :sonarcloud-api-token-cred-id: Jenkins credential ID which has the SonarCloud API Token. + This one SHOULDN'T be overwritten as 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: openjdk17) :stream: Keyword that represents a release code-name. Often the same as the branch. (default: master) :submodule-recursive: Whether to checkout submodules recursively. @@ -589,8 +649,10 @@ 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-java-version: Version of Java to use for the Sonar scan. (default: openjdk11) + :sonarcloud-api-token-cred-id: Jenkins credential ID which has the SonarCloud API Token. + This one SHOULDN'T be overwritten as 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: openjdk17) :sonarcloud-qualitygate-wait: SonarCloud flag that forces the analysis step to wait for the quality gate result. (default: false) :stream: Keyword that represents a release code-name.