Add sphinx link to rtd jobs page

[releng/global-jjb.git] / README.md

diff --git a/README.md b/README.md
index bc6fcc7..50d9c6e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,12 +10,14 @@ be available.
 For example:
 
 ```
+GERRIT_URL=https://git.opendaylight.org/gerrit
 GIT_URL=ssh://jenkins-$SILO@git.opendaylight.org:29418
 GIT_CLONE_URL=git@github.com:
 JENKINS_HOSTNAME=jenkins092
 LOGS_SERVER=https://logs.opendaylight.org
 NEXUS_URL=https://nexus.opendaylight.org
 SILO=releng
+SONAR_URL=https://sonar.opendaylight.org
 ```
 
 Note: Use **GIT_CLONE_URL** for GitHub projects as this
@@ -28,11 +30,21 @@ configuration.
 
 - Config File Provider
 - Description Setter
-- Gerrit Trigger
+- Environment Injector Plugin
+- Git plugin
 - Post Build Script
 - SSH Agent
 - Workspace Cleanup
 
+**Required for Gerrit connected systems**
+
+- Gerrit Trigger
+
+**Required for GitHub connected systems**
+
+- GitHub plugin
+- GitHub Pull Request Builder
+
 **Optional**
 
 - Mask Passwords
@@ -105,6 +117,16 @@ trigger any job that uses the `lf-infra-github-pr-trigger` macro.
 privileges on any job using the `lf-infra-github-pr-trigger`
 macro.
 
+**lftools-version**: Version of lftools to install. Can be a specific version
+like '0.6.1' or a PEP-440 definition. <https://www.python.org/dev/peps/pep-0440/>
+For example `<1.0.0` or `>=1.0.0,<2.0.0`.
+
+**mvn-site-id**: Maven Server ID from settings.xml containing the credentials
+to push to a Maven site repository.
+
+**mvn-staging-id**: Maven Server ID from settings.xml containing the credentials
+to push to a Maven staging repository.
+
 defaults.yaml:
 
 ```
@@ -121,6 +143,8 @@ defaults.yaml:
       - zxiiro
     github_pr_admin_list:
       - tykeal
+    lftools-version: '<1.0.0'
+    mvn-site-id: opendaylight-site
 ```
 
 ## Config File Management
@@ -271,6 +295,17 @@ In this method a job can define a globstar for example `**/*.log` which then
 causes the archive script to do a globstar search for that pattern and archives
 any files it finds matching.
 
+## Overriding merge and verify triggers
+
+The default trigger conditions for Merge and Verify job types are overrideable
+in a project configuration by overriding the following variables:
+
+- gerrit_merge_triggers
+- gerrit_verify_triggers
+
+These variables take a list of trigger-on values as defined in JJB docs here:
+<https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit>
+
 ## Appendix
 
 ### ShellCheck