Update build-timeout parameter documentation

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

diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst
index 980e867..9b19ae1 100644 (file)
--- a/docs/jjb/lf-python-jobs.rst
+++ b/docs/jjb/lf-python-jobs.rst
@@ -27,6 +27,35 @@ Jobs for Python projects using GitHub.
 Macros
 ======
 
+lf-infra-clm-python
+-------------------
+
+Run CLM scanning against a Python project.
+
+:Required Parameters:
+
+    :clm-project-name: Project name in Nexus IQ to send results to.
+
+lf-infra-tox-install
+--------------------
+
+Install Tox into a virtualenv.
+
+:Required Parameters:
+
+    :python-version: Version of Python to install into the Tox virtualenv.
+        Eg. python2 / python3
+
+lf-infra-tox-sonar
+------------------
+
+Runs Sonar scanning against a Python project.
+
+:Required Parameters:
+
+    :java-version: Version of Java to use to run Sonar.
+    :mvn-version: Version of Maven to use to run Sonar.
+
 lf-tox-install
 --------------
 
@@ -67,7 +96,7 @@ IQ Server.
 
     :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)
+    :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)
     :stream: Keyword used to represent a release code-name.
@@ -75,6 +104,11 @@ IQ Server.
     :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
 ---------------------
@@ -122,7 +156,7 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import
 :Optional parameters:
 
     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
-    :build-timeout: Timeout in seconds before aborting build. (default: 60)
+    :build-timeout: Timeout in minutes before aborting build. (default: 60)
     :cron: Cron schedule when to trigger the job. This parameter also
         supports multiline input via YAML pipe | character in cases where
         one may want to provide more than 1 cron timer.  (default: H 11 * * *
@@ -131,12 +165,17 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import
     :java-version: Version of Java to use for the build. (default: openjdk8)
     :mvn-global-settings: The name of the Maven global settings to use for
         Maven configuration. (default: global-settings)
-    :mvn-version: Version of maven to use. (default: mvn33)
+    :mvn-version: Version of maven to use. (default: mvn35)
     :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_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
 ----------
@@ -167,7 +206,7 @@ following pyenv variables before running.
 
     :branch: The branch to build against. (default: master)
     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
-    :build-timeout: Timeout in seconds before aborting build. (default: 10)
+    :build-timeout: Timeout in minutes before aborting build. (default: 10)
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
     :python-version: Version of Python to configure as a base in virtualenv.
         (default: python3)
@@ -180,3 +219,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