X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-maven-jobs.rst;h=3a2a088c20b8dc6f3fe5dffd27a24c626150daa0;hb=2f43e2ee13855a63f793d2991f1a3dbf064c1cec;hp=ccd4165211ad721918fdfc8624e2631c853de505;hpb=0840b7680f4cf261282d60b8b733ecb6437f9f04;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst index ccd41652..3a2a088c 100644 --- a/docs/jjb/lf-maven-jobs.rst +++ b/docs/jjb/lf-maven-jobs.rst @@ -5,48 +5,12 @@ Maven Jobs 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: - - - gerrit-maven-clm - - gerrit-maven-release - - gerrit-maven-verify - - gerrit-maven-verify-dependencies - -{project-name}-github-maven-jobs --------------------------------- - -Jobs for Maven projects using GitHub. - -:Includes: - - - github-maven-clm - - github-maven-release - - github-maven-verify - -{project-name}-maven-javadoc-jobs ---------------------------------- - -Jobs for Maven projects to generate javadoc using Gerrit. - -:Includes: - - - gerrit-maven-javadoc-publish - - gerrit-maven-javadoc-verify - -{project-name}-github-maven-javadoc-jobs ----------------------------------------- - -Jobs for Maven projects to generate javadoc using GitHub. - -:Includes: - - - github-maven-javadoc-publish - - github-maven-javadoc-verify +.. literalinclude:: ../../jjb/lf-maven-job-groups.yaml + :language: yaml Macros @@ -112,6 +76,8 @@ Produces a CLM scan of the code into Nexus IQ Server. - gerrit-maven-clm - github-maven-clm +:Comment Trigger: run-clm + :Required parameters: :build-node: The node to run build on. @@ -126,17 +92,28 @@ Produces a CLM scan of the code into Nexus IQ Server. :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-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) :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: 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') + :ossrh-profile-id: Profile ID for project as provided by OSSRH. + (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_merge_triggers: Override Gerrit Triggers. @@ -153,6 +130,8 @@ Expects javadocs to be available in $WORKSPACE/target/site/apidocs - gerrit-maven-javadoc-publish - github-maven-javadoc-publish +:Comment Trigger: remerge + :Required parameters: :build-node: The node to run build on. @@ -179,6 +158,8 @@ Expects javadocs to be available in $WORKSPACE/target/site/apidocs 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. @@ -195,6 +176,8 @@ Expects javadocs to be available in $WORKSPACE/target/site/apidocs - 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 @@ -218,6 +201,8 @@ Expects javadocs to be available in $WORKSPACE/target/site/apidocs 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. @@ -245,6 +230,8 @@ This job uses the following strategy to deploy jobs to Nexus: - gerrit-maven-merge - github-maven-merge +:Comment Trigger: remerge + :Required parameters: :build-node: The node to run build on. @@ -276,24 +263,29 @@ This job uses the following strategy to deploy jobs to Nexus: 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 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: @@ -322,10 +314,13 @@ directory can then be reused later to deploy to Nexus. :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) + :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. @@ -344,6 +339,8 @@ interest in that kind of support. - gerrit-maven-sonar - github-maven-sonar +:Comment Trigger: run-sonar + :Required parameters: :build-node: The node to run build on. @@ -370,6 +367,8 @@ interest in that kind of support. 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. @@ -384,6 +383,8 @@ Verify job which runs mvn clean install to test a project build.. - gerrit-maven-verify - github-maven-verify +:Comment Trigger: recheck|reverify + :Required parameters: :build-node: The node to run build on. @@ -407,6 +408,8 @@ Verify job which runs mvn clean install to test a project build.. 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 @@ -451,6 +454,8 @@ via comment trigger. 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