e165b78546
For users in a proxy environment, checking the doc urls requires being able to pass through the proxy environment variables. Include a simple comment along with the tox command requiring it to help users checking any links added are valid. Add some references to documentation, both in the detailed documentation and the quick README.rst that would be more commonly checked. Change-Id: I2316bc1b7e845c29a8b248eef4668a6099d109f7
108 lines
3.2 KiB
ReStructuredText
108 lines
3.2 KiB
ReStructuredText
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:
|
|
|
|
* http://docs.openstack.org/infra/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
|
|
|
|
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:
|
|
|
|
* 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.
|
|
|
|
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
|
|
|
|
.. _Jenkins: https://jenkins.io/
|
|
.. _YAML: http://www.yaml.org/
|
|
.. _JSON: http://json.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
|