sipwise
/
jenkins-job-builder
mirror of https://github.com/sipwise/jenkins-job-builder.git
1
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
741 Commits
2 Branches
78 Tags
38 MiB
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f594fb5c7c'
${ noResults }
Go to file
Khai Do f594fb5c7c
reference tests as examples 		12 years ago
doc Test creation of multiple jobs from templates 12 years ago
etc Added config options to not overwrite jobs desc 12 years ago
jenkins_jobs Merge "Fail if specified set of defaults is not found." 12 years ago
samples reference tests as examples 12 years ago
tests scms: MultiSCM is generated for scms hidden in macro 12 years ago
tools Migrate to pbr 12 years ago
.gitignore Doc: Use VersionInfo from pbr and remove openstack common modules 12 years ago
.gitreview Updated .gitreview location 13 years ago
.testr.conf Tests for publishers 13 years ago
LICENSE Add a LICENSE file. 13 years ago
MANIFEST.in Just give in and use setuptools_git. 13 years ago
README.rst Merge "README.rst: Add links" 12 years ago
openstack-common.conf Add openstack-common support for setup and version 13 years ago
requirements.txt Migrate to pbr 12 years ago
setup.cfg add overview info to pypi 12 years ago
setup.py Migrate to pbr 12 years ago
test-requirements.txt Add hacking to requirements 12 years ago
tox.ini Add hacking to requirements 12 years ago

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:

* http://ci.openstack.org/jenkins-job-builder/

Developers
==========
Bug report:

* https://bugs.launchpad.net/openstack-ci/

Cloning:

* 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://wiki.openstack.org/HowToContribute

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

.. _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