Tools to make Jenkins jobs from templates
Go to file
Benjamin Staffin 72c02d4106 Clean up a few errant tabs in setup.cfg
Change-Id: I0d353fa30c1e53620064fe01f2c1f691b6588fd8
2014-03-24 19:32:09 -07:00
doc Use venv to build documentation 2014-03-02 10:56:40 +01:00
etc Enable ignore_cache flag on jenkins_jobs.ini 2013-12-10 12:59:13 +01:00
jenkins_jobs Merge "Fix typo in ircbot's default matrix-notifier." 2014-03-25 00:18:34 +00:00
samples Add Release plugin 2013-06-11 23:15:55 +00:00
tests Merge "Fix typo in ircbot's default matrix-notifier." 2014-03-25 00:18:34 +00:00
tools Migrate to pbr 2014-03-14 22:25:46 +01:00
.gitignore stop ignoring doc/source/* 2013-09-23 17:49:48 +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
README.rst Update README for project move. 2012-12-16 20:27:42 +00:00
openstack-common.conf Add openstack-common support for setup and version 2012-11-10 23:36:16 +00:00
requirements.txt Migrate to pbr 2014-03-14 22:25:46 +01:00
setup.cfg Clean up a few errant tabs in setup.cfg 2014-03-24 19:32:09 -07:00
setup.py Migrate to pbr 2014-03-14 22:25:46 +01:00
test-requirements.txt Migrate to pbr 2014-03-14 22:25:46 +01:00
tox.ini Migrate to pbr 2014-03-14 22:25:46 +01: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