X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-maven-jobs.rst;h=411a712642ad7d8838421268e314c0cf267fe64e;hb=refs%2Ftags%2Fv0.75.0;hp=ffbbedc31da4f18d9478b5acafd92a8e2cccaf34;hpb=dfc4b07132cce65541bc8f2bf1e3bd4920a4ef90;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst index ffbbedc3..411a7126 100644 --- a/docs/jjb/lf-maven-jobs.rst +++ b/docs/jjb/lf-maven-jobs.rst @@ -23,7 +23,7 @@ Runs Sonar against a Maven project. :Required Parameters: - :java-version: Version of Java to execute Sonar with. + :java-version: Version of Java to execute Sonar with. (default: openjdk11) :mvn-version: Version of Maven to execute Sonar with. :mvn-settings: Maven settings.xml file containing credentials to use. @@ -34,13 +34,15 @@ Runs Sonar against a Maven project and pushes results to SonarCloud. :Required Parameters: - :java-version: Version of Java to execute Maven build. (default: openjdk8) + :java-version: Version of Java to execute Maven build. (default: openjdk11) :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. + :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) lf-maven-build -------------- @@ -95,7 +97,7 @@ Setup Java alternatives for the Distro. :Required Parameters: :java-version: Version of Java to set as the default Java. - Eg. openjdk8 + Eg. openjdk11 lf-infra-sonatype-clm --------------------- @@ -107,6 +109,15 @@ Nexus IQ server. :mvn-goals: The maven goals to perform for the build. (default: clean install) +lf-infra-maven-sbom-generator +----------------------------- + +Runs a specific version of SPDX SBOM Generator tool to generate a report. +The calling job template sets the version to run in the SBOM_GENERATOR_VERSION parameter. + +:Optional parameters: + :sbom-flags: SBOM generator options. See https://github.com/opensbom-generator/spdx-sbom-generator + Job Templates ============= @@ -135,7 +146,7 @@ Produces a CLM scan of the code into Nexus IQ Server. :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: openjdk8) + :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. @@ -192,7 +203,7 @@ in ``$WORKSPACE/{mvn-dir}/target/site/apidocs``. :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: openjdk8) + :java-version: Version of Java to use for the build. (default: openjdk11) :mvn-dir: Directory supplied as argument to -f option (default: '.') :mvn-global-settings: The name of the Maven global settings to use for Maven configuration. (default: global-settings) @@ -240,7 +251,7 @@ in ``$WORKSPACE/{mvn-dir}/target/site/apidocs``. :build-timeout: Timeout in minutes before aborting build. (default: 60) :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM) :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 build. (default: openjdk11) :mvn-dir: Directory supplied as argument to -f option (default: '.') :mvn-global-settings: The name of the Maven global settings to use for Maven configuration. (default: global-settings) @@ -304,7 +315,7 @@ 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) - :java-version: Version of Java to use for the build. (default: openjdk8) + :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-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '') @@ -390,7 +401,7 @@ directory is then used later to deploy to Nexus. one may want to provide more than 1 cron timer. (default: '') :deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM) :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 build. (default: openjdk11) :mvn-central: Set to ``true`` to also stage to **OSSRH**. This is for projects that want to release to Maven Central. If set, then also set the parameter ``ossrh-profile-id``. (default: false) @@ -402,6 +413,12 @@ directory is then used later to deploy to Nexus. :mvn-version: Version of maven to use. (default: mvn35) :ossrh-profile-id: Profile ID for project as provided by OSSRH. (default: '') + :sbom-flags: SBOM generator options if using sbom-generator. + See https://github.com/opensbom-generator/spdx-sbom-generator + :sbom-generator: Calls lf-infra-maven-sbom-generator to run the SPDX SBOM generator tool. + (default: false) + :sbom-generator-version: SBOM generator version to download and run if using sbom-generator. + (default: v0.0.10) :sign-artifacts: Sign artifacts with Sigul. (default: false) :stream: Keyword that represents a release code-name. Often the same as the branch. (default: master) @@ -490,7 +507,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 Maven build. (default: openjdk8) + :java-version: Version of Java to use for the Maven 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. @@ -521,6 +538,69 @@ multi-branch configuration. :gerrit_sonar_triggers: Override Gerrit Triggers. +SonarCloud Example: + +.. literalinclude:: ../../.jjb-test/lf-maven-jobs/maven-sonarcloud.yaml + :language: yaml + +Maven Sonar Verify +------------------ + +Sonar job which runs mvn clean install then publishes to Sonar. + +This job runs on dev branches and its triggered on new patchsets. + +:Template Names: + + - {project-name}-sonar-verify + - gerrit-maven-sonar-verify + +:Comment Trigger: recheck|reverify + +: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. + +:Optional parameters: + + :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 Maven 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) + :sonar-mvn-goal: Maven goals to run for sonar analysis. + (default: sonar:sonar) + :sonarcloud: Set to ``true`` to use SonarCloud ``true|false``. + (default: true) + :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-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. + 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) + :scan-dev-branch: Run the scan on a developer branch. + (default: true) + + :gerrit_sonar_triggers: Override Gerrit Triggers. + + SonarCloud Example: .. literalinclude:: ../../.jjb-test/lf-maven-jobs/maven-sonarcloud.yaml @@ -551,7 +631,7 @@ Verify job which runs mvn clean install to test a project build.. :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: openjdk8) + :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-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '') @@ -619,7 +699,7 @@ comment trigger. :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: openjdk8) + :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-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')