aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPaul Sokolovsky <paul.sokolovsky@linaro.org>2015-03-05 22:48:18 +0200
committerFathi Boudra <fathi.boudra@linaro.org>2015-03-06 10:14:32 +0200
commitb1d86571521faeaf837660f524125866e0e3130a (patch)
tree60d4be22d4bd3775e058873f9d4821d1300ed201 /README
parent8ce1700cbcef92c2947894186f266f035064208f (diff)
README: add information about jenkins-job-builder usage
Change-Id: If070edc8cb3de28a3ceac1209bba94f30208d707 Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org> Signed-off-by: Fathi Boudra <fathi.boudra@linaro.org>
Diffstat (limited to 'README')
-rw-r--r--README39
1 files changed, 32 insertions, 7 deletions
diff --git a/README b/README
index 6ee3b628..1a18fe64 100644
--- a/README
+++ b/README
@@ -1,13 +1,19 @@
This repository contains the Jenkins job configurations used by Linaro CI.
-Jenkins job builder
+Jenkins Job Builder
===================
-Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format,
-and uses them to configure Jenkins.
+Jenkins Job Builder (jjb) takes simple descriptions of Jenkins jobs in YAML
+format, and uses them to configure Jenkins.
-Configurations
-==============
+Homepage: http://ci.openstack.org/jjb.html
+
+Note that Linaro CI may use a modified Jenkins Job Builder and may include
+some patches which are not yet upstreamed. These changes are included in
+latest Debian/Ubuntu packages.
+
+Job Configurations
+==================
In order to keep the jobs consistent, please follow this guideline:
* Job name
@@ -16,8 +22,27 @@ In order to keep the jobs consistent, please follow this guideline:
* YAML
- file name matching the job name
+Workflow
+========
+
+Changes made to this repository are monitored and trigger an automatic
+deployment on the Jenkins master instance.
+
+Note: changes made through Jenkins web interface will be LOST.
+
+To manually force a Jenkins job update:
+1. Install jenkins-job-builder package
+2. Copy provided jenkins_jobs.ini-sample to jenkins_jobs.ini
+3. Edit jenkins_jobs.ini user/password settings as appropriate
+4. Run the job builder in test mode:
+
+ jenkins-jobs --conf=jenkins_jobs.ini test <job>.yaml
+
+4. Update the job on the Jenkins master:
+
+ jenkins-jobs --conf=jenkins_jobs.ini update <job>.yaml
+
TODO
-====
+----
* YAML header contains maintainer name
* enable markdown formatter
-