jjb
/
jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
2,989 Commits 1 Branch 41 Tags 35 MiB
Python 99.1%
Shell 0.7%
Go to file
Thanh Ha 4d90c187a9 Auto-generated output from python-black 
Please review the following patch containing the code changes in
the repo. This patch is a transition patch and is the auto-generated
output of the python-black tool.

Change-Id: I2d2de71da8a105fb62b561899ae78441ddab4032
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
 		2019-09-09 19:23:24 +01:00
doc Auto-generated output from python-black 2019-09-09 19:23:24 +01:00
etc Add update option to the JJB config sample 2018-09-25 19:52:20 +05:30
jenkins_jobs Auto-generated output from python-black 2019-09-09 19:23:24 +01:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Auto-generated output from python-black 2019-09-09 19:23:24 +01:00
tools Replace openstack.org git:// URLs with https:// 2019-03-24 20:33:56 +00:00
.gitignore Merge "Add .venv to .gitignore" 2018-11-14 23:56:26 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:49:46 +00:00
.pre-commit-config.yaml Fix flake8 failures and make its execution more consistent 2018-10-28 11:44:43 +00:00
.stestr.conf Replace testr with stestr 2018-04-05 12:14:13 +01:00
.zuul.yaml OpenDev Migration Patch 2019-04-19 19:49:46 +00: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 adopt pre-commit hooks 2018-07-12 13:40:38 +01:00
docs-requirements.txt Add a requirements file for readthedocs 2015-07-27 06:40:49 -07:00
requirements.txt Allow pyyaml >= 5 2019-04-08 13:29:43 +02:00
setup.cfg Auto-generated output from python-black 2019-09-09 19:23:24 +01:00
setup.py Auto-generated output from python-black 2019-09-09 19:23:24 +01:00
test-requirements.txt Correct dependencies on tox linters 2019-07-13 15:19:54 +01:00
tox.ini Correct dependencies on tox linters 2019-07-13 15:19:54 +01: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

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 Freenode

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