From: Jessica Wagantall <jwagantall@linuxfoundation.org>
Date: Fri, 20 Apr 2018 00:44:06 +0000 (-0700)
Subject: Add docs for Python XC CLM
X-Git-Tag: v0.19.0~13
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=4f358d51cab0ccdac984e3549e3b818cb5323abc;p=releng%2Fglobal-jjb.git

Add docs for Python XC CLM

Add documentation for Python XC CLM:
- Description of the job
- Job templates
- Description of parameters

Changes made in response to the comments in
I5e5c420539ab3a3e5b292620da4418c16d557221

Change-Id: I19713d37aa38159f26e437c961b6d1b4fa6f77fc
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
---

diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst
index 85103dbe..980e8678 100644
--- a/docs/jjb/lf-python-jobs.rst
+++ b/docs/jjb/lf-python-jobs.rst
@@ -41,6 +41,41 @@ 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.
+
 Python Sonar with Tox
 ---------------------