Enable archive pattern support

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

diff --git a/README.md b/README.md
index edba0d9..4c21ec6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -74,6 +74,13 @@ Trigger global configuration.
 **jenkins-ssh-credential**: The name of the Jenkins Credential to use for ssh
 connections.
 
+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)
+
+**github-org**: The name of the GitHub organization.
+
 defaults.yaml:
 
 ```
@@ -83,6 +90,7 @@ defaults.yaml:
     # lf-infra defaults
     jenkins-ssh-credential: opendaylight-jenkins-ssh
     gerrit-server-name: OpenDaylight
+    github-org: lfit
 ```
 
 ## Config File Management
@@ -124,3 +132,18 @@ Optional parameters:
 
 **branch**: is the git branch to build from.
 **jjb-version**: is the version of JJB to install in the build minion.
+
+## Archiving logs in Jobs
+
+There are 2 ways supported for archiving log information:
+
+1) Job creates $WORKSPACE/archives directory and places logs there
+
+In this method the entire archives directory will be pushed to the log server
+in the same structure as configured in the archives directory.
+
+2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
+
+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.