Tools to make Jenkins jobs from templates
Go to file
Vsevolod Fedorov 35a75d28e5 Add support for Python 3.11
Change-Id: I4db0a458e054becc924726f25fff2cf0a80f3cc9
2023-12-19 12:10:43 +03:00
doc Story: 2010984 Fix folder tests and defaults for folders 2023-12-04 10:51:55 +03:00
etc Add update option to the JJB config sample 2018-09-25 19:52:20 +05:30
jenkins_jobs Fix legacy plugin version comparison; Remove cap on setuptools version 2023-12-19 12:10:43 +03:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Fix legacy plugin version comparison; Remove cap on setuptools version 2023-12-19 12:10:43 +03:00
tools Replace openstack.org git:// URLs with https:// 2019-03-24 20:33:56 +00:00
.gitignore Add TAGS file to .gitignore 2022-06-09 11:40:58 +03:00
.gitreview OpenDev Migration Patch 2019-04-19 19:49:46 +00:00
.pre-commit-config.yaml Update Zuul CI 2022-12-19 16:19:22 +03:00
.zuul.yaml Add support for Python 3.11 2023-12-19 12:10:43 +03: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 Update documentation links 2023-11-09 12:24:34 +03:00
docs-requirements.txt Add a requirements file for readthedocs 2015-07-27 06:40:49 -07:00
requirements.txt Fix legacy plugin version comparison; Remove cap on setuptools version 2023-12-19 12:10:43 +03:00
setup.cfg fix: Drop testing for Python 3.6 2022-04-12 12:28:03 -04:00
setup.py Auto-generated output from python-black 2019-09-09 19:23:24 +01:00
test-requirements.txt Move tests to pytest 2022-12-20 10:44:43 +03:00
tox.ini Add support for Python 3.11 2023-12-19 12:10:43 +03: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://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.

Mailing list:

IRC:

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

Unit tests could be run in parallel, using pytest-parallel pytest plugin:

tox -e py38 -- --workers=auto
  • 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