Tools to make Jenkins jobs from templates
Go to file
Paul Belanger 329633da6d Convert our README to ReStructuredText
This should make pypi.python.org happier!

Change-Id: I2e82bf8cb81545831bdb864b049d01e3faffabb9
Signed-off-by: Paul Belanger <paul.belanger@polybeacon.com>
Reviewed-on: https://review.openstack.org/16486
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Tested-by: Jenkins
2012-11-20 17:38:01 +00:00
doc Add option to block up|down stream builds. 2012-11-17 01:25:17 +00:00
etc Add sample jenkins_jobs.ini configuration file 2012-10-30 19:22:36 +00:00
jenkins_jobs Add copyartifact builder to entry points and fix target attribute 2012-11-19 21:49:37 +00:00
samples Do not output XML if job name not specified ('pipeline', 'trigger-builds') 2012-10-30 16:32:39 +00:00
tools Do not output XML if job name not specified ('pipeline', 'trigger-builds') 2012-10-30 16:32:39 +00:00
.gitignore Update tox to exclude *egg for pep8 2012-11-20 17:03:18 +00:00
.gitreview Add .gitreview. 2012-08-06 20:25:20 +00: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
README.rst Convert our README to ReStructuredText 2012-11-20 17:38:01 +00:00
openstack-common.conf Add openstack-common support for setup and version 2012-11-10 23:36:16 +00:00
setup.cfg Add openstack-common support for setup and version 2012-11-10 23:36:16 +00:00
setup.py Just give in and use setuptools_git. 2012-11-20 14:15:58 +00:00
tox.ini Update tox to exclude *egg for pep8 2012-11-20 17:03:18 +00: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