https://github.com/bootswithdefer/jenkins-job-builder
https://github.com/bootswithdefer/jenkins-job-builder
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bootswithdefer/jenkins-job-builder
- Owner: bootswithdefer
- License: apache-2.0
- Created: 2015-03-16T00:52:11.000Z (over 11 years ago)
- Default Branch: github
- Last Pushed: 2015-03-21T20:14:12.000Z (about 11 years ago)
- Last Synced: 2025-01-21T14:46:02.347Z (over 1 year ago)
- Language: Python
- Size: 1.63 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
README
======
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:
* http://ci.openstack.org/jenkins-job-builder/
Developers
----------
Bug report:
* https://storyboard.openstack.org/#!/project/723
Repository:
* https://git.openstack.org/cgit/openstack-infra/jenkins-job-builder
Cloning::
git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
Patches are submitted via Gerrit at:
* https://review.openstack.org/
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:
* http://docs.openstack.org/infra/manual/developers.html
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
.. _Jenkins: http://jenkins-ci.org/
.. _YAML: http://www.yaml.org/
.. _pep8: https://pypi.python.org/pypi/pep8
.. _pyflakes: https://pypi.python.org/pypi/pyflakes
.. _tox: https://testrun.org/tox
.. _libyaml: http://pyyaml.org/wiki/LibYAML
.. _pip: https://pypi.python.org/pypi/pip