jjb/jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
407 Commits 1 Branch 45 Tags 36 MiB
Python 99%
Shell 0.7%
C++ 0.2%
d18c3cb1f5
Go to file
Khai Do d18c3cb1f5 Add usage info to JJB documentation 
Display the usage info for JJB and add it to the
sphinx docs.

Fixes bug 1221944

Change-Id: I5b36cca7a836b009bfb0ca880abbccd4477de307
2013-09-09 15:14:18 -07:00
doc Add usage info to JJB documentation 2013-09-09 15:14:18 -07:00
etc Add sample jenkins_jobs.ini configuration file 2012-10-30 19:22:36 +00:00
jenkins_jobs Merge "Added support for JaCoCo plugin Publisher" 2013-09-08 04:32:29 +00:00
samples Add Release plugin 2013-06-11 23:15:55 +00:00
tests Add python26 multiline string assertion back. 2013-07-24 13:40:33 -07:00
tools Add usage info to JJB documentation 2013-09-09 15:14:18 -07:00
.gitignore Tests for publishers 2013-07-19 14:31:11 +02:00
.gitreview Updated .gitreview location 2012-12-16 20:32:35 +00:00
.testr.conf Tests for publishers 2013-07-19 14:31:11 +02:00
LICENSE Add a LICENSE file. 2012-11-16 00:22:31 +00:00
MANIFEST.in Just give in and use setuptools_git. 2012-11-20 14:15:58 +00:00
openstack-common.conf Add openstack-common support for setup and version 2012-11-10 23:36:16 +00:00
README.rst Update README for project move. 2012-12-16 20:27:42 +00:00
setup.cfg Add openstack-common support for setup and version 2012-11-10 23:36:16 +00:00
setup.py Merge "Added support for JaCoCo plugin Publisher" 2013-09-08 04:32:29 +00:00
tox.ini Add python26 support 2013-07-19 23:29:29 -04:00

README.rst

Jenkins Job Builder

Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format, and uses them to configure Jenkins. You can keep your job descriptions in human readable text format in a version control system to make changes and auditing easier. It also has a flexible template system, so creating many similarly configured jobs is easy.

To install:

$ sudo python setup.py install

Online documentation:

Developers

Bug report:

Cloning:

Patches are submitted via Gerrit at:

More details on how you can contribute is available on our wiki at:

Writing a patch

We ask that all code submissions be pep8 and pyflakes clean. The easiest way to do that is to run tox before submitting code for review in Gerrit. It will run pep8 and pyflakes in the same manner as the automated test suite that will run on proposed patchsets.

When creating new YAML components, please observe the following style conventions:

  • All YAML identifiers (including component names and arguments) should be lower-case and multiple word identifiers should use hyphens. E.g., "build-trigger".
  • The Python functions that implement components should have the same name as the YAML keyword, but should use underscores instead of hyphens. E.g., "build_trigger".

This consistency will help users avoid simple mistakes when writing YAML, as well as developers when matching YAML components to Python implementation.

Installing without setup.py

For YAML support, you will need libyaml installed.

Mac OS X:

$ brew install libyaml

Then install the required python packages using pip:

$ sudo pip install PyYAML python-jenkins