jjb/jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
2,249 Commits 1 Branch 44 Tags 36 MiB
Python 99%
Shell 0.7%
C++ 0.2%
13f122b11b
Go to file
Jenkins 13f122b11b Merge "Update trigger_remote to make use of convert_mapping_to_xml"
2017-06-27 16:13:08 +00:00
doc Add option to make test output file layout match Jenkins 2017-05-27 12:22:06 +01:00
etc Add convenience function for plugin namespace 2016-11-11 13:34:16 -05:00
jenkins_jobs Merge "Update trigger_remote to make use of convert_mapping_to_xml" 2017-06-27 16:13:08 +00:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Merge "Update description_setter plugin" 2017-06-27 15:22:21 +00:00
tools Remove dead tool jenkins-jobs.py 2016-09-26 16:03:11 -07:00
.gitignore Removed some deprecation warnings and enabled py35 on tox. 2017-03-12 19:43:33 +00: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 Add comment about proxy env pass through 2016-09-15 11:33:35 +01:00
requirements.txt Sync requirements with openstack/requirements 2016-12-10 09:42:57 -06:00
setup.cfg setup.cfg: use project homepage 2017-05-10 15:07:53 -06:00
setup.py Sync requirements with openstack/requirements 2016-12-10 09:42:57 -06:00
test-requirements.txt Sync requirements with openstack/requirements 2016-12-10 09:42:57 -06:00
tox.ini Removed some deprecation warnings and enabled py35 on tox. 2017-03-12 19:43:33 +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:

$ pip install --user jenkins-job-builder

Online documentation:

Developers

Bug report:

Repository:

Cloning:

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

A virtual environment is recommended for development. For example, Jenkins Job Builder may be installed from the top level directory:

$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -r test-requirements.txt -e .

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.

Unit Tests

Unit tests have been included and are in the tests folder. Many unit tests samples are included as examples in our documentation to ensure that examples are kept current with existing behaviour. To run the unit tests, execute the command:

tox -e py34,py27
  • Note: View tox.ini to run tests on other versions of Python, generating the documentation and additionally for any special notes on running the test to validate documentation external URLs from behind proxies.

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