X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-python-jobs.rst;h=6288c4daca725ff3c99bf0c0d651eda74bf986a4;hb=aa256b7a0769f6c9c9906cacb4d87f49e691622c;hp=85103dbe604679ee7209e37448249efc15eb7f74;hpb=d8598304d2156c39d702bb5e087b802602f503a4;p=releng%2Fglobal-jjb.git

diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst
index 85103dbe..6288c4da 100644
--- a/docs/jjb/lf-python-jobs.rst
+++ b/docs/jjb/lf-python-jobs.rst
@@ -41,6 +41,46 @@ Runs a shell script that installs tox in a Python virtualenv.
 Job Templates
 =============
 
+Python XC CLM
+-------------
+
+CLM scans for Python based repos. This job will call the Nexus IQ CLI
+directly to run the scans.
+
+A new credential named "nexus-iq-xc-clm" needs to exist in the Jenkins credentials.
+The credential should contain the username and password to access Nexus
+IQ Server.
+
+:Template Names:
+
+    - {project-name}-python-clm-{stream}
+    - gerrit-python-xc-clm
+    - github-python-xc-clm
+
+:Required parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+        get configured in defaults.yaml)
+
+:Optional parameters:
+
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :nexus-iq-cli-version: Nexus IQ CLI package version to download and use. (default: 1.44.0-01)
+    :build-timeout: Timeout in seconds 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)
+    :stream: Keyword used to represent a release code-name.
+        Often the same as the branch. (default: master)
+    :submodule-recursive: Whether to checkout submodules recursively.
+        (default: true)
+    :gerrit_clm_triggers: Override Gerrit Triggers.
+    :gerrit_trigger_file_paths: Override file paths which used to filter which
+        file modifications will trigger a build. Refer to JJB documentation for
+        "file-path" details.
+        https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
+
+
 Python Sonar with Tox
 ---------------------
 
@@ -102,6 +142,11 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
     :gerrit_sonar_triggers: Override Gerrit Triggers.
+    :gerrit_trigger_file_paths: Override file paths which used to filter which
+        file modifications will trigger a build. Refer to JJB documentation for
+        "file-path" details.
+        https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
+
 
 Tox Verify
 ----------
@@ -145,3 +190,7 @@ following pyenv variables before running.
         (default: '')
     :tox-envs: Tox environments to run. If blank run everything described
         in tox.ini. (default: '')
+    :gerrit_trigger_file_paths: Override file paths which used to filter which
+        file modifications will trigger a build. Refer to JJB documentation for
+        "file-path" details.
+        https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit