2d1494d3a3
Change I059f38d0aa8a8947aaac75e0ddb34d392063ece3 added support for passing parameters to jobs in groups but not for variable substitution on those parameters. Substitution on job list parameters would be a new feature. This change removes a misleading parameter subsitution example. Partial-bug: #1298568 Change-Id: I18e28bb622f0473f049963ce6dcf6c4efd11dc2c |
||
---|---|---|
doc | ||
etc | ||
jenkins_jobs | ||
samples | ||
tests | ||
tools | ||
.gitignore | ||
.gitreview | ||
.testr.conf | ||
LICENSE | ||
MANIFEST.in | ||
README.rst | ||
openstack-common.conf | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.rst
Jenkins Job Builder
Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML 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:
$ sudo python setup.py install
Online documentation:
Developers
Bug report:
Cloning:
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