Merge "Refactor staging-profile-id out of mvn-parameters"

[releng/global-jjb.git] / docs / jjb / lf-maven-jobs.rst

diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst
index 9835e66..02de9f1 100644 (file)
--- a/docs/jjb/lf-maven-jobs.rst
+++ b/docs/jjb/lf-maven-jobs.rst
@@ -13,7 +13,7 @@ Jobs for Maven projects using Gerrit.
 :Includes:
 
     - gerrit-maven-clm
-    - gerrit-maven-release
+    - gerrit-maven-stage
     - gerrit-maven-verify
     - gerrit-maven-verify-dependencies
 
@@ -25,7 +25,7 @@ Jobs for Maven projects using GitHub.
 :Includes:
 
     - github-maven-clm
-    - github-maven-release
+    - github-maven-stage
     - github-maven-verify
 
 {project-name}-maven-javadoc-jobs
@@ -112,6 +112,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.
@@ -131,6 +133,8 @@ Produces a CLM scan of the code into Nexus IQ Server.
     :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-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.
@@ -151,6 +155,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.
@@ -193,6 +199,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
@@ -243,6 +251,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.
@@ -279,19 +289,22 @@ This job uses the following strategy to deploy jobs to Nexus:
     :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:
 
@@ -342,6 +355,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.
@@ -382,6 +397,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.