jjb/jenkins-job-builder
Code Issues Proposed changes
0941c3ad36
jenkins-job-builder/README.rst
Jeremy Stanley e3a72b3034 Update README for project move. 
* README.rst: Correct clone URL.

Change-Id: I830e3bfbca6c537dce78449110b1c6d444a0574b
Reviewed-on: https://review.openstack.org/18199
Approved: James E. Blair <corvus@inaugust.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
2012-12-16 20:27:42 +00:00

1.9 KiB
Raw Blame History

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