Tools to make Jenkins jobs from templates
Go to file
Nicolas Glayre 3809cecef7 Modifying .gitignore file to add .idea folder
To not commit jetbrains project folder

Change-Id: I4ccb34558f29f60967d3c6602dff6abc31778807
2015-12-21 13:40:19 +01:00
doc Merge "Add MultiJob Project Documentation." 2015-12-03 05:08:28 +00:00
etc Stash publisher's credentials configuration 2015-08-24 15:23:47 +02:00
jenkins_jobs Merge "Adding a new project parameter on multijob" 2015-12-18 13:20:07 +00:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Adding a new project parameter on multijob 2015-12-15 17:14:18 +01:00
tools Change zuul-cloner parameters 2015-06-15 11:08:08 -07:00
.gitignore Modifying .gitignore file to add .idea folder 2015-12-21 13:40:19 +01: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
docs-requirements.txt Add a requirements file for readthedocs 2015-07-27 06:40:49 -07: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 Document that jjb supports json job definitions 2015-07-28 17:20:29 -07:00
requirements.txt Merge "Improve delete all job performance" 2015-09-18 17:35:02 +00:00
setup.cfg Infer and build entry points from component modules 2015-12-12 19:07:26 +00:00
setup.py Migrate to pbr 2014-03-14 22:25:46 +01:00
test-requirements.txt Update sphinx to be compatible with readthedocs.org 2015-09-28 20:46:42 +00:00
tox.ini Merge "Stop specifying requirements.txt in tox.ini" 2015-09-08 08:32:27 +00:00

README

Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML or JSON 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:

Repository:

Cloning:

git clone https://git.openstack.org/openstack-infra/jenkins-job-builder

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