jjb
/
jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
179 Commits 1 Branch 42 Tags 35 MiB
Python 99%
Shell 0.7%
C++ 0.2%
Go to file
Tollef Fog Heen ff2f3f7505 Fix up description of text_param and file_param 
Change-Id: Ief99fab872a531402c0907b4f44defce37d249e1
Reviewed-on: https://review.openstack.org/15189
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Tested-by: Jenkins
 		2012-11-01 23:12:50 +00:00
doc Fix up examples so they're at least syntactically valid 2012-10-31 10:01:29 +00:00
etc Add sample jenkins_jobs.ini configuration file 2012-10-30 19:22:36 +00:00
jenkins_jobs Fix up description of text_param and file_param 2012-11-01 23:12:50 +00:00
samples Do not output XML if job name not specified ('pipeline', 'trigger-builds') 2012-10-30 16:32:39 +00:00
tools Do not output XML if job name not specified ('pipeline', 'trigger-builds') 2012-10-30 16:32:39 +00:00
.gitignore Add documentation. 2012-09-17 20:25:38 +00:00
.gitreview Add .gitreview. 2012-08-06 20:25:20 +00:00
README.md Add some style developer docs. 2012-11-01 14:59:48 +00:00
jenkins-jobs fallback to ./jenkins_job.ini conf 2012-10-12 16:05:44 +00:00
setup.cfg Add documentation. 2012-09-17 20:25:38 +00:00
setup.py Adding ability to use the Build Name Setter Plugin 2012-11-01 21:06:09 +00:00
tox.ini Add documentation. 2012-09-17 20:25:38 +00:00

README.md

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: https://bugs.launchpad.net/openstack-ci/

Cloning: https://github.com/openstack-ci/jenkins-job-builder.git

Patches are submitted via Gerrit at https://review.openstack.org/

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