Jenkins Job Builder¶
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.
$ pip install --user jenkins-job-builder
git clone https://opendev.org/jjb/jenkins-job-builder.git
Install pre-commit from https://pre-commit.com/#intro 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.
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
pyflakes in the same
manner as the automated test suite that will run on proposed
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 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
Unit tests could be run in parallel, using pytest-parallel pytest plugin:
tox -e py38 -- --workers=auto
tox.inito 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
- Quick Start Guide
- Configuration File
- Job Definitions
- Custom Yaml Tags
- ExternalJob Project
- Flow Project
- Folder Project
- Freestyle Project
- GitHub Organization Project
- Matrix Project
- Maven Project
- MultiJob Project
- Pipeline Project
- Workflow Project
- Multibranch Pipeline Project
- Delivery Pipeline View
- List View
- Nested View
- Pipeline View
- Module Execution