Tools to make Jenkins jobs from templates
Go to file
Clark Boylan 8b982ed886 Handle utf8 in JJB
JJB didn't actually handle unicode data very well for a couple reasons.
First the local yaml loader was loading files into yaml as strings
instead of unicode which we should just go ahead and do because yaml's
built int loader loads utf-8 by default (and we don't override the
default). Second we need to do parameter substitution on unicode and
regular strings so change the substitution typecheck to use basestring
instead of str. Finally we need to use UTF-8 as the encoding when
emitting XML so do that.

Add tests to actually test this in the yamlparser tests. The addition of
these new tests comes with a little bit of cleanup in the test classes
to make sure we load unicode files as utf8 more consistently.

Change-Id: I2169e19aae2cdc7ddbd1e7217ef7584c786a039a
Fixes-bug: 1361090
2014-08-29 14:19:21 -07:00
doc Apply defaults to job-templates parameters 2014-08-22 23:35:54 +02:00
etc Use yaml local tags to support including files 2014-06-20 23:16:23 +01:00
jenkins_jobs Handle utf8 in JJB 2014-08-29 14:19:21 -07:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Handle utf8 in JJB 2014-08-29 14:19:21 -07:00
tools Migrate to pbr 2014-03-14 22:25:46 +01:00
.gitignore Add tox "coverage" target 2014-05-27 16:50:34 -07:00
.gitreview Updated .gitreview location 2012-12-16 20:32:35 +00:00
.testr.conf Tests for publishers 2013-07-19 14:31:11 +02:00
LICENSE Add a LICENSE file. 2012-11-16 00:22:31 +00:00
MANIFEST.in Just give in and use setuptools_git. 2012-11-20 14:15:58 +00:00
README.rst Merge "README.rst: Add links" 2014-04-22 20:20:26 +00:00
openstack-common.conf Add openstack-common support for setup and version 2012-11-10 23:36:16 +00:00
requirements.txt Argparse is required for JJB to parse arguments 2014-07-27 00:49:51 +01:00
setup.cfg Merge "Add support for the Jenkins Valgrind publisher plugin." 2014-08-26 17:06:08 +00:00
setup.py Migrate to pbr 2014-03-14 22:25:46 +01:00
test-requirements.txt Argparse is required for JJB to parse arguments 2014-07-27 00:49:51 +01:00
tox.ini Work around PYTHONHASHSEED-related problems 2014-08-22 18:01:23 -05:00

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