Tools to make Jenkins jobs from templates
Go to file
Darragh Bailey f68831bd2e Only query jenkins plugins if config provided
Limit querying for plugin information from Jenkins to where an explicit
configuration file has been provided. Where no file is provided, should
avoid any requests that could result in attempting connections.

Add a config options to control this behaviour explicitly so that if a
config file is provided, it may explicitly disable querying jenkins for
additional information from plugins.

The `test` command can use this behaviour to ensure that a basic run is
possible without providing any configuration files, and can be
explicitly configured to disable querying should a config file be used
for testing.

Ensure the default sample configuration skips attempting to query so
that users may use it as a quick test for a working installation without
any network or valid jenkins url dependencies.

Change-Id: I641a3188013debf3765aaff109c4f5fa82a4cedb
2015-04-17 17:16:33 +01:00
doc Only query jenkins plugins if config provided 2015-04-17 17:16:33 +01:00
etc Only query jenkins plugins if config provided 2015-04-17 17:16:33 +01:00
jenkins_jobs Only query jenkins plugins if config provided 2015-04-17 17:16:33 +01:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Only query jenkins plugins if config provided 2015-04-17 17:16:33 +01:00
tools Fix jenkins-job-builder-compare-xml job by using zuul-cloner 2015-03-25 15:25:06 -07:00
.gitignore Ignore testr_subunit_log 2014-10-21 11:02:40 +08: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 Check external documentation links are valid 2015-02-24 21:36:54 +00:00
requirements.txt Depend on python-jenkins 0.4.1 or later 2015-02-06 14:26:56 +00:00
setup.cfg Merge "Add support for Sonar analysis builder" 2015-04-03 18:11:35 +00:00
setup.py Migrate to pbr 2014-03-14 22:25:46 +01:00
test-requirements.txt Move ordereddict to requirements 2014-09-04 14:58:20 +01:00
tox.ini Rename doc environment to docs 2014-09-08 13:47:26 -07:00

README.rst

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:

Developers

Bug report:

Repository:

Cloning:

git clone https://git.openstack.org/openstack-infra/jenkins-job-builder

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