dfc0efb79c
It came to my attention when I was deciding whether or not to use the jenkins_jobs.parallel.parallelize decorator to parallelize things in jenkins_jobs.parser that because it is using the Python threading library nothing is actually parallelized, only concurrentized (at least for CPython). I actually think concurrency is fine for the original use case since that (ie, updating Jenkins jobs) is primarily I/O bound on network connections to a Jenkins instance. However, the "parallel" name really is misleading and could actually be harmful for users of this API who may mistakenly have the impression that it can be used to speed up CPU-bound tasks. Also removes seemingly unnecessary usages of this decorator. ie, jenkins_jobs.builder.Jenkins.changed that is never actually calle with a list of arguments. Change-Id: I996f9dea440e2d6b67ea70870d22942d6eef3ec7 |
||
---|---|---|
doc | ||
etc | ||
jenkins_jobs | ||
samples | ||
tests | ||
tools | ||
.gitignore | ||
.gitreview | ||
.testr.conf | ||
docs-requirements.txt | ||
LICENSE | ||
MANIFEST.in | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
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
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 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.
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