Add triggers to jenkins-cfg job

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

diff --git a/docs/jjb/lf-ci-jobs.rst b/docs/jjb/lf-ci-jobs.rst
index 3ddec14..19de22d 100644 (file)
--- a/docs/jjb/lf-ci-jobs.rst
+++ b/docs/jjb/lf-ci-jobs.rst
@@ -59,6 +59,11 @@ Manages the Global Jenkins variables. This macro will clear all exist macros
 in Jenkins and replaces them with the ones defined by the
 ci-management/jenkins-config/global-vars-SILO.sh script.
 
+.. note::
+
+   Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
+   config definitions for "production" and "sandbox" systems.
+
 :Required parameters:
 
     :jenkins-silos: Space separated list of Jenkins silos to update
@@ -125,6 +130,11 @@ The format for this file is ``KEY=value`` for example::
     SILO=sandbox
     SONAR_URL=https://sonar.opendaylight.org
 
+.. note::
+
+   Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
+   config definitions for "production" and "sandbox" systems.
+
 :Template names:
 
     - {project-name}-jenkins-cfg-merge
@@ -133,6 +143,8 @@ The format for this file is ``KEY=value`` for example::
 
 :Optional parameters:
 
+    :branch: Git branch to build against. (default: master)
+    :cron: How often to run the job on a cron schedule. (default: @daily)
     :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
     :jenkins-silos: Space separated list of Jenkins silos to update
         configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini