jjb/jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
1,501 Commits 1 Branch 46 Tags 36 MiB
Python 99%
Shell 0.7%
C++ 0.2%
a796a593dc
Go to file
Darragh Bailey a796a593dc Standardize docstrings for properties module 
Move remaining examples to unit tests, remove unnecessary '\' and align
docstrings to the predominate standard throughout the project.

Fix broken authenticated-build highlighted by the added unit test.

Change-Id: Ic9700f587073946be17be543920a4a3ed7cd19d0
2015-12-12 19:01:10 +00: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 Standardize docstrings for properties module 2015-12-12 19:01:10 +00:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Standardize docstrings for properties module 2015-12-12 19:01:10 +00:00
tools Change zuul-cloner parameters 2015-06-15 11:08:08 -07:00
.gitignore Ignore testr_subunit_log 2014-10-21 11:02:40 +08: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 Add support for cucumber reports plugin 2015-12-11 23:20:57 +08: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.rst

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