Job Groups
==========
-{project-name}-maven-jobs
--------------------------
+.. include:: ../job-groups.rst
-Jobs for Maven projects using Gerrit.
+Below is a list of Maven job groups:
-:Includes:
+.. literalinclude:: ../../jjb/lf-maven-job-groups.yaml
+ :language: yaml
- - gerrit-maven-clm
- - gerrit-maven-release
- - gerrit-maven-verify
- - gerrit-maven-verify-dependencies
-{project-name}-github-maven-jobs
---------------------------------
+Macros
+======
-Jobs for Maven projects using GitHub.
+lf-infra-maven-sonar
+--------------------
-:Includes:
+Runs Sonar against a Maven project.
- - github-maven-clm
- - github-maven-release
- - github-maven-verify
+:Required Parameters:
-{project-name}-maven-javadoc-jobs
----------------------------------
+ :java-version: Version of Java to execute Sonar with.
+ :mvn-version: Version of Maven to execute Sonar with.
+ :mvn-settings: Maven settings.xml file containing credentials to use.
-Jobs for Maven projects to generate javadoc using Gerrit.
+lf-infra-maven-sonarcloud
+-------------------------
-:Includes:
+Runs Sonar against a Maven project and pushes results to SonarCloud.
- - gerrit-maven-javadoc-publish
- - gerrit-maven-javadoc-verify
+:Required Parameters:
-{project-name}-github-maven-javadoc-jobs
-----------------------------------------
+ :java-version: Version of Java to execute Sonar with.
+ :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.
-Jobs for Maven projects to generate javadoc using GitHub.
+lf-maven-build
+--------------
-:Includes:
-
- - github-maven-javadoc-publish
- - github-maven-javadoc-verify
+Calls the maven build script to perform a maven build.
+:Required parameters:
-Macros
-======
+ :mvn-goals: The maven goals to perform for the build.
+ (default: clean deploy)
lf-maven-common
---------------
Calls the maven deploy script to push artifacts to Nexus.
+lf-maven-versions-plugin
+------------------------
+
+Conditionally calls Maven versions plugin to set, update and commit the maven `versions:set`.
+
+:Required Parameters:
+
+ :maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
+ :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.
+
+:Required Parameters:
+
+ :mvn-global-settings: The name of the Maven global settings to use for
+ Maven configuration.
+ :mvn-settings: The name of settings file containing credentials for the project.
+
+lf-update-java-alternatives
+---------------------------
+
+Setup Java alternatives for the Distro.
+
+:Required Parameters:
+
+ :java-version: Version of Java to set as the default Java.
+ Eg. openjdk8
+
Job Templates
=============
- gerrit-maven-clm
- github-maven-clm
+:Comment Trigger: run-clm
+
:Required parameters:
:build-node: The node to run build on.
: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 seconds before aborting build. (default: 60)
+ :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)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
+ :nexus-iq-namespace: Insert a namespace to project AppID for projects that
+ share a Nexus IQ system to avoid project name collision. We recommend
+ inserting a trailing - dash if using this parameter.
+ For example 'odl-'. (default: '')
+ :nexus-iq-stage: Stage the policy evaluation will be run against on
+ the Nexus IQ Server. (default: 'build')
:stream: Keyword that can be used to represent 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)
:gerrit_merge_triggers: Override Gerrit Triggers.
:Template Names:
- - {project-name}-maven-javadoc-publish-{stream}
+ - {project-name}-maven-javadoc-publish-{stream}-{java-version}
- gerrit-maven-javadoc-publish
- github-maven-javadoc-publish
+:Comment Trigger: remerge
+
:Required parameters:
:build-node: The node to run build on.
: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 seconds before aborting build. (default: 60)
+ :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)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent 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)
:gerrit_merge_triggers: Override Gerrit Triggers.
:Template Names:
- - {project-name}-maven-javadoc-verify-{stream}
+ - {project-name}-maven-javadoc-verify-{stream}-{java-version}
- gerrit-maven-javadoc-verify
- github-maven-javadoc-verify
+:Comment Trigger: recheck|reverify
+
:Required parameters:
:build-node: The node to run build on.
:jenkins-ssh-credential: Credential to use for SSH. (Generally should
: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 seconds before aborting build. (default: 60)
+ :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)
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent 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)
:gerrit_verify_triggers: Override Gerrit Triggers.
- gerrit-maven-merge
- github-maven-merge
+:Comment Trigger: remerge
+
:Required parameters:
:build-node: The node to run build on.
:branch: Git branch to fetch for the build. (default: master)
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ :build-timeout: Timeout in minutes before aborting build. (default: 60)
:cron: Cron schedule when to trigger the job. This parameter also
supports multiline input via YAML pipe | character in cases where
one may want to provide more than 1 cron timer. (default: 'H H * * 0'
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
:nexus-cut-dirs: Number of directories to cut from file path for `wget -r`.
:stream: Keyword that can be used to represent 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)
: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 Release
--------------
+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
+-----------
Produces a release candidate by creating a staging repo in Nexus.
-Runs a Maven build and deploys to $WORKSPACE/m2repo directory. This
-directory can then be reused later to deploy to Nexus.
+The staging repo name is in the format PROJECT-NUMBER for example "aaa-1234",
+"autorelease-2000", "odlparent-1201", etc...
+
+This job runs a Maven build and deploys to $WORKSPACE/m2repo directory. This
+directory is then used later to deploy to Nexus.
:Template Names:
- - {project-name}-maven-release-{stream}
- - gerrit-maven-release
- - github-maven-release
+ - {project-name}-maven-stage-{stream}
+ - gerrit-maven-stage
+ - github-maven-stage
:Required parameters:
:archive-artifacts: Artifacts to archive to the logs server (default: '').
: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 seconds before aborting build. (default: 60)
+ :build-timeout: Timeout in minutes before aborting build. (default: 60)
:cron: Cron schedule when to trigger the job. This parameter also
supports multiline input via YAML pipe | character in cases where
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)
+ :mvn-central: Set to 'true' to also stage to OSSRH. This is for projects
+ that want to release to Maven Central. If set the parameter
+ ``ossrh-profile-id`` also needs to be set. (default: false)
+ :maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
+ :ossrh-profile-id: Profile ID for project as provided by OSSRH.
+ (default: '')
+ :sign-artifacts: Sign artifacts with Sigul. (default: false)
:stream: Keyword that can be used to represent 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)
:gerrit_release_triggers: Override Gerrit Triggers.
+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
+
+:Required parameters:
+
+ :container-public-registry: Docker registry source with base images.
+ :container-staging-registry: Docker registry target for the deploy action.
+
+All other required and optional parameters are identical to the Maven Stage job
+described above.
+
+.. _maven-sonar:
+
Maven Sonar
-----------
- gerrit-maven-sonar
- github-maven-sonar
+:Comment Trigger: run-sonar
+
:Required parameters:
:build-node: The node to run build on.
:Optional parameters:
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ :build-timeout: Timeout in minutes before aborting build. (default: 60)
:cron: Cron schedule when to trigger the job. This parameter also
supports multiline input via YAML pipe | character in cases where
one may want to provide more than 1 cron timer. (default: 'H H * * 6'
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
+ :sonar-mvn-goals: Maven goals to run for sonar analysis.
+ (default: sonar:sonar)
+ :sonarcloud: Whether or not to use SonarCloud ``true|false``.
+ (default: false)
+ :sonarcloud-project-key: SonarCloud project key. (default: '')
+ :sonarcloud-project-organization: SonarCloud project organization.
+ (default: '')
+ :sonarcloud-api-token: SonarCloud API Token. (default: '')
:stream: Keyword that can be used to represent 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)
:gerrit_sonar_triggers: Override Gerrit Triggers.
+
+SonarCloud Example:
+
+.. literalinclude:: ../../.jjb-test/lf-maven-jobs/maven-sonarcloud.yaml
+ :language: yaml
+
Maven Verify
------------
- gerrit-maven-verify
- github-maven-verify
+:Comment Trigger: recheck|reverify
+
:Required parameters:
:build-node: The node to run build on.
:branch: Git branch to fetch for the build. (default: master)
:build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in seconds before aborting build. (default: 60)
+ :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)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent 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)
: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
- {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:
Maven configuration. (default: global-settings)
: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: mvn33)
+ :mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent 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)
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths which can be used to
Code Review / releng / global-jjb.git / blobdiff