Add branches parameter to github scm macro

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

diff --git a/README.md b/README.md
index 00f1279..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
@@ -109,6 +121,12 @@ macro.
 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:
 
 ```
@@ -126,6 +144,7 @@ defaults.yaml:
     github_pr_admin_list:
       - tykeal
     lftools-version: '<1.0.0'
+    mvn-site-id: opendaylight-site
 ```
 
 ## Config File Management