jjb/jenkins-job-builder
Code Issues Proposed changes
90af7a8fc6
jenkins-job-builder/README.rst
Marc Abramowitz 3beff4d255 README.rst: Note GitHub PRs are auto-closed 
This makes it a little bit clearer that GitHub pull requests are not
accepted and will be automatically closed.

This is a small tweak to help with one of the issues mentioned here:

http://www.alexconrad.org/2014/04/the-painful-process-of-submitting-your.html

Change-Id: Ie4aa8297a75f00ddd9e6c0fce722aa7a6586d52d
2014-04-19 20:28:54 -07:00

2.0 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:

Please do not submit GitHub pull requests, they will be automatically closed.

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