Add override for GT file-paths in Python jobs

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

diff --git a/README.md b/README.md
index 00f1279..fa5a914 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
@@ -26,19 +28,35 @@ configuration.
 
 **Required**
 
-- Config File Provider
-- Description Setter
-- Gerrit Trigger
-- Post Build Script
-- SSH Agent
-- Workspace Cleanup
+- [Config File Provider](https://plugins.jenkins.io/config-file-provider)
+- [Description Setter](https://plugins.jenkins.io/description-setter)
+- [Environment Injector Plugin](https://plugins.jenkins.io/envinject)
+- [Git plugin](https://plugins.jenkins.io/git)
+- [Post Build Script](https://plugins.jenkins.io/postbuildscript)
+
+    Due to security concerns Post Build Script is not available through
+    the Jenkins update center and must install it manually. You can
+    download it
+    [here](https://updates.jenkins-ci.org/download/plugins/postbuildscript/).
+
+- [SSH Agent](https://plugins.jenkins.io/ssh-agent)
+- [Workspace Cleanup](https://plugins.jenkins.io/ws-cleanup)
+
+**Required for Gerrit connected systems**
+
+- [Gerrit Trigger](https://plugins.jenkins.io/gerrit-trigger)
+
+**Required for GitHub connected systems**
+
+- [GitHub plugin](https://plugins.jenkins.io/github)
+- [GitHub Pull Request Builder](https://plugins.jenkins.io/ghprb)
 
 **Optional**
 
-- Mask Passwords
-- MsgInject
-- OpenStack Cloud
-- Timestamps
+- [Mask Passwords](https://plugins.jenkins.io/mask-passwords)
+- [MsgInject](https://plugins.jenkins.io/msginject)
+- [OpenStack Cloud](https://plugins.jenkins.io/openstack-cloud)
+- [Timestamps](https://plugins.jenkins.io/timestamper)
 
 ## Installing global-jjb
 
@@ -53,7 +71,11 @@ versioned git tags.
     # Add the new submodule to ci-management's jjb directory.
     # Note: Perform once per ci-management repo.
     cd jjb/
-    git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb
+
+    # For production deployments:
+    git submodule add https://github.com/lfit/releng-global-jjb global-jjb
+    # For test deployments comment the above and uncomment the below
+    # git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb
 
     # Checkout the version of global-jjb you wish to deploy.
     cd global-jjb
@@ -109,6 +131,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 +154,7 @@ defaults.yaml:
     github_pr_admin_list:
       - tykeal
     lftools-version: '<1.0.0'
+    mvn-site-id: opendaylight-site
 ```
 
 ## Config File Management