Install virtualenvs into /tmp/v

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

diff --git a/README.md b/README.md
index 01388fc..0ce3c24 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,10 @@ 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.

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


@@ -124,18 +131,53 @@ ci-management.yaml:
 
 Required parameters:
 
 
 Required parameters:
 

-**project**: is the project repo as defined in Gerrit.
+**project**: is the project repo as defined in source control.

 **project-name**: is a custom name to call the job in Jenkins.
 **build-node**: is the name of the builder to use when building (Jenkins label).
 
 Optional parameters:
 
 **branch**: is the git branch to build from.
 **project-name**: is a custom name to call the job in Jenkins.
 **build-node**: is the name of the builder to use when building (Jenkins label).
 
 Optional parameters:
 
 **branch**: is the git branch to build from.

-**git-url**: is used to override the GIT_URL environment variable. Should not
-             be necessary in most cases. Mainly used by LF projects such as
-             global-jjb and lftools.

 **jjb-version**: is the version of JJB to install in the build minion.
 
 **jjb-version**: is the version of JJB to install in the build minion.
 

+## Deploying Python jobs
+
+We provide the following Python jobs templates:
+
+### {project-name}-tox-verify-{stream}
+
+This job can be used to call python-tox to run builds and tests. The most common
+usage of this job is to run the Coala linter against projects.
+
+```
+- project:
+    name: builder
+    jobs:
+        - '{project-name}-tox-verify-{stream}'
+
+    project-name: builder
+    project: releng/builder
+    build-node: centos7-java-builder-2c-4g
+    stream: master
+```
+
+Required parameters:
+
+**project**: is the project repo as defined in source control.
+**project-name**: is a custom name to call the job in Jenkins.
+**build-node**: is the name of the builder to use when building (Jenkins label).
+**stream**: typically `master` or matching whatever branch is being built. This
+            is a useful keywords to map a release codename to a branch. For
+            example OpenDaylight uses this to map stream=carbon to
+            branch=stable/carbon.
+
+Optional parameters:
+
+**branch**: is the git branch to build from.
+**jjb-version**: is the version of JJB to install in the build minion.
+**tox-dir**: directory containing tox.ini file (default: '')
+**tox-envs**: tox environments to run (default: '')
+

 ## Archiving logs in Jobs
 
 There are 2 ways supported for archiving log information:
 ## Archiving logs in Jobs
 
 There are 2 ways supported for archiving log information: