jjb
/
jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
1,038 Commits 1 Branch 41 Tags 35 MiB
Python 99.1%
Shell 0.7%
Go to file
Darragh Bailey 89f266d9a2 Fix formatting for inclusion of README.rst 
The contents of README.rst are included directly into the documentation
index file, as a result we need to alter the formatting to align with
the existing contents.

Change-Id: I4e5720790e277377638001c1feddf5779e07238b
 		2015-02-04 12:55:53 +00:00
doc Fix invalid link to jenkins puppet module 2015-02-02 10:52:04 -08:00
etc Merge "Error on duplicate job names being found" 2014-10-14 22:03:58 +00:00
jenkins_jobs Merge "Add example to demonstrate flow plugin for job-template" 2015-02-04 12:50:09 +00:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Merge "Add example to demonstrate flow plugin for job-template" 2015-02-04 12:50:09 +00:00
tools Switch to new project-config repo 2014-09-30 18:24:08 +01: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
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 Fix formatting for inclusion of README.rst 2015-02-04 12:55:53 +00:00
requirements.txt Make JJB python 3 compatible 2014-10-06 15:24:16 +01:00
setup.cfg Merge "Add support for M2 repository cleanup plugin" 2015-02-04 03:19:12 +00:00
setup.py Migrate to pbr 2014-03-14 22:25:46 +01:00
test-requirements.txt Move ordereddict to requirements 2014-09-04 14:58:20 +01:00
tox.ini Rename doc environment to docs 2014-09-08 13:47:26 -07:00

README.rst

README

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:

Repository:

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