Refactor job-groups documentation

[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 ccd4165..74a3e7e 100644 (file)
--- 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.
@@ -153,6 +119,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.
@@ -195,6 +163,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
@@ -245,6 +215,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.
@@ -281,19 +253,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:
 
@@ -344,6 +319,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.
@@ -384,6 +361,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.