Tools to make Jenkins jobs from templates
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Zuul a191e0b174
Merge "wrappers: omit blank settings for ssh-user-private-key credential"
7 months ago
doc Update documentation, tox environment 7 months ago
etc Add update option to the JJB config sample 4 years ago
jenkins_jobs Merge "wrappers: omit blank settings for ssh-user-private-key credential" 7 months ago
samples reference tests as examples 9 years ago
tests Merge "wrappers: omit blank settings for ssh-user-private-key credential" 7 months ago
tools Replace git:// URLs with https:// 4 years ago
.gitignore Add TAGS file to .gitignore 8 months ago
.gitreview OpenDev Migration Patch 4 years ago
.pre-commit-config.yaml Bumping black to 22.3.0 10 months ago
.stestr.conf Replace testr with stestr 5 years ago
.zuul.yaml Run tox linters on zuul check 8 months ago
LICENSE Add a LICENSE file. 10 years ago Just give in and use setuptools_git. 10 years ago
README.rst Fix!: Remove support for EOL python versions 10 months ago
docs-requirements.txt Add a requirements file for readthedocs 8 years ago
requirements.txt requirements.txt: Avoid depending on PyYAML<6 10 months ago
setup.cfg fix: Drop testing for Python 3.6 10 months ago Auto-generated output from python-black 3 years ago
test-requirements.txt Fix: Update sphinx version pin, fix warnings 10 months ago
tox.ini fix: Drop testing for Python 3.6 10 months ago



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:


Bug report:



git clone

Install pre-commit from in order to run some minimal testing on your commits.

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.

Mailing list:


  • #openstack-jjb on OFTC

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 py38
  • 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

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