jjb/jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
3,179 Commits 1 Branch 46 Tags 36 MiB
Python 99%
Shell 0.7%
C++ 0.2%
352b93d586
Go to file
Jiri Podivin 352b93d586 Bumping black to 22.3.0 
Setting desired version of black to 22.3.0 prevents issues with
the click dependency described in the #1966879.

Introduction of black 22.3.0 forced style changes in following files:
- doc/source/conf.py
- jenkins_jobs/local_yaml.py
- tests/base.py

These changes do not modify behavior of the programs concerned.

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: I42a46f9ed31ea0f404d698eec73d30975e2e6f4c
2022-03-31 09:27:41 +02:00
doc Bumping black to 22.3.0 2022-03-31 09:27:41 +02:00
etc Add update option to the JJB config sample 2018-09-25 19:52:20 +05:30
jenkins_jobs Bumping black to 22.3.0 2022-03-31 09:27:41 +02:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Bumping black to 22.3.0 2022-03-31 09:27:41 +02: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 Bumping black to 22.3.0 2022-03-31 09:27:41 +02:00
.stestr.conf Replace testr with stestr 2018-04-05 12:14:13 +01:00
.zuul.yaml Enable official support for Python 3.7 / 3.8 2021-01-07 00:43:58 +01: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 Update IRC network to OFTC 2021-06-01 16:21:09 -04:00
requirements.txt force pre 2.0 stevedore on Python 2 2020-09-08 09:28:29 +02:00
setup.cfg Feat: Add GitHub Organization job type 2021-07-09 16:46:11 -07:00
setup.py Auto-generated output from python-black 2019-09-09 19:23:24 +01:00
test-requirements.txt Fix CI for Python 2 2022-02-11 13:03:56 +01:00
tox.ini Enable official support for Python 3.7 / 3.8 2021-01-07 00:43:58 +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://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 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