Add lf-infra-docker-login macro and script

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

diff --git a/README.md b/README.md
index 6c68417..cbaaa29 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,11 +11,15 @@ For example:
 
 ```
 GIT_URL=ssh://jenkins-$SILO@git.opendaylight.org:29418
 
 ```
 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
 ```
 JENKINS_HOSTNAME=jenkins092
 LOGS_SERVER=https://logs.opendaylight.org
 NEXUS_URL=https://nexus.opendaylight.org
 SILO=releng
 ```

+Note: **GIT_CLONE_URL** is only used by Github projects as this
+will be different from the URL used the poperties
+configuration.

 
 ## Jenkins Plugin Requirements
 
 
 ## Jenkins Plugin Requirements
 


@@ -77,7 +81,14 @@ connections.
 If you are using GitHub then there are two more parameters which
 will need to be placed in the defaults.yaml
 
 If you are using GitHub then there are two more parameters which
 will need to be placed in the defaults.yaml
 

-**github-url**: The URL of GitHub. (Default: https://github.com)
+**git-url**: This should be set to the base URL of your GitHub. In
+general this should be https://github.com. If you are using GitHub
+Enterprise, or some other GitHub-style system, then it should be
+whatever your installation base URL is.
+
+**git-clone-url**: This is the clone prefix used by GitHub jobs. This
+should be set to either the same thing as **git-url** or the
+'git@github.com:' including the trailing ':'

 
 **github-org**: The name of the GitHub organization.
 
 
 **github-org**: The name of the GitHub organization.