X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-maven-jobs.rst;h=bdee524a9307be971e0f33d16df973cd92b3c3f6;hb=6c2d75d8776959527346a9ea5095e4b0228adc70;hp=306ef8e4d348126c1f1b1357438bf396cbbc23ba;hpb=bfea76c9bead88faf10a3ad41ae98ad741ac1b91;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst index 306ef8e4..bdee524a 100644 --- a/docs/jjb/lf-maven-jobs.rst +++ b/docs/jjb/lf-maven-jobs.rst @@ -69,12 +69,14 @@ Conditionally calls Maven versions plugin to set, update and commit the maven `v :Required Parameters: :maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false) + :version-properties-file: Name and path of the version properties file. + (default: version.properties) :mvn-version: Version of Maven to execute Sonar with. :mvn-pom: Location of pom.xml. :mvn-settings: Maven settings.xml file containing credentials to use. lf-maven-stage ---------------- +-------------- Calls the maven stage script to push artifacts to a Nexus staging repository. @@ -94,6 +96,16 @@ Setup Java alternatives for the Distro. :java-version: Version of Java to set as the default Java. Eg. openjdk8 +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) + Job Templates ============= @@ -126,6 +138,8 @@ Produces a CLM scan of the code into Nexus IQ Server. :java-version: Version of Java to use for the 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. + (default: clean install) :mvn-opts: Sets MAVEN_OPTS. (default: '') :mvn-params: Additional mvn parameters to pass to the cli. (default: '') :mvn-version: Version of maven to use. (default: mvn35) @@ -141,6 +155,8 @@ Produces a CLM scan of the code into Nexus IQ Server. (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :gerrit_merge_triggers: Override Gerrit Triggers. @@ -187,6 +203,8 @@ Expects javadocs to be available in $WORKSPACE/target/site/apidocs (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :gerrit_merge_triggers: Override Gerrit Triggers. @@ -230,6 +248,8 @@ Expects javadocs to be available in $WORKSPACE/target/site/apidocs (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :gerrit_verify_triggers: Override Gerrit Triggers. @@ -292,11 +312,40 @@ This job uses the following strategy to deploy jobs to Nexus: (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :gerrit_merge_triggers: Override Gerrit Triggers. :gerrit_trigger_file_paths: Override file paths which can be used to filter which file modifications will trigger a build. +Maven Merge for Docker +---------------------- + +Produces a snapshot docker image in a Nexus registry. Appropriate for +Java projects that do not need to deploy any POM or JAR files. + +Similar to Maven Merge as described above but logs in to Docker +registries first and skips the lf-maven-deploy builder. The project +POM file should invoke a plugin to build and push a Docker image. The +base image should be pulled from the registry in the environment +variable CONTAINER_PULL_REGISTRY. The new image should be pushed to the +registry in the environment variable CONTAINER_PUSH_REGISTRY. + +:Template Names: + + - {project-name}-maven-docker-merge-{stream} + - gerrit-maven-docker-merge + - github-maven-docker-merge + +:Required parameters: + + :container-public-registry: Docker registry source with base images. + :container-snapshot-registry: Docker registry target for the deploy action. + +All other required and optional parameters are identical to the Maven Merge job +described above. + Maven Stage ----------- @@ -314,6 +363,8 @@ directory is then used later to deploy to Nexus. - gerrit-maven-stage - github-maven-stage +:Comment Trigger: "stage-release" or "stage-maven-release" + :Required parameters: :build-node: The node to run build on. @@ -354,8 +405,48 @@ directory is then used later to deploy to Nexus. (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) + :version-properties-file: Name and path of the version properties file. + (default: version.properties) :gerrit_release_triggers: Override Gerrit Triggers. + :gerrit_trigger_file_paths: Override file paths which can be used to + filter which file modifications will trigger a build. + +Maven Stage for Docker +---------------------- + +Produces a release candidate docker image in a Nexus registry. +Appropriate for Java projects that do not need to deploy any POM or +JAR files. + +Similar to Maven Stage as described above but logs in to Docker +registries first and skips the lf-maven-deploy builder. The project +POM file should invoke a plugin to build and push a Docker image. The +base image should be pulled from the registry in the environment +variable CONTAINER_PULL_REGISTRY. The new image should be pushed to the +registry in the environment variable CONTAINER_PUSH_REGISTRY. + +:Template Names: + + - {project-name}-maven-docker-stage-{stream} + - gerrit-maven-docker-stage + - github-maven-docker-stage + +:Comment Trigger: "stage-release" or "stage-docker-release" + +:Required parameters: + + :container-public-registry: Docker registry source with base images. + :container-staging-registry: Docker registry target for the deploy action. + +:Optional parameters: + + :gerrit_release_docker_triggers: Override Gerrit Triggers. + +All other required and optional parameters are identical to the Maven Stage job +described above. .. _maven-sonar: @@ -395,6 +486,8 @@ interest in that kind of support. :java-version: Version of Java to use for the 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. + (default: clean install) :mvn-opts: Sets MAVEN_OPTS. (default: '') :mvn-params: Additional mvn parameters to pass to the cli. (default: '') :mvn-version: Version of maven to use. (default: mvn35) @@ -412,6 +505,8 @@ interest in that kind of support. (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :gerrit_sonar_triggers: Override Gerrit Triggers. @@ -459,12 +554,35 @@ Verify job which runs mvn clean install to test a project build.. (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :gerrit_verify_triggers: Override Gerrit Triggers. :gerrit_trigger_file_paths: Override file paths which can be used to filter which file modifications will trigger a build. -Maven Verify /w Dependencies +Maven Verify for Docker +----------------------- + +Similar to Maven Verify as described above but logs in to Docker +registries first. The project POM file should invoke a plugin to build +a Docker image. The base image should be pulled from the registry in +the environment variable CONTAINER_PULL_REGISTRY. + +:Template Names: + + - {project-name}-maven-docker-verify-{stream}-{mvn-version}-{java-version} + - gerrit-maven-docker-verify + - github-maven-docker-verify + +:Required parameters: + + :container-public-registry: Docker registry source with base images. + +All other required and optional parameters are identical to the Maven Verify job +described above. + +Maven Verify w/ Dependencies ---------------------------- Verify job which runs mvn clean install to test a project build /w deps @@ -478,7 +596,7 @@ via comment trigger. - {project-name}-maven-verify-deps-{stream}-{mvn-version}-{java-version} - gerrit-maven-verify-dependencies -:Comment Trigger: recheck: SPACE_SEPERATED_LIST_OF_PATCHES +:Comment Trigger: recheck: SPACE_SEPARATED_LIST_OF_PATCHES :Required parameters: @@ -505,6 +623,8 @@ via comment trigger. (default: true) :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :gerrit_verify_triggers: Override Gerrit Triggers. :gerrit_trigger_file_paths: Override file paths which can be used to