jjb/jenkins-job-builder
Code Issues Proposed changes
Tools to make Jenkins jobs from templates
1,970 Commits 1 Branch 45 Tags 36 MiB
Python 99%
Shell 0.7%
C++ 0.2%
784de85973
Go to file
Ryo Tagami 784de85973 Add Workflow Project Documentation 
Even though the module for workflow project (a.k.a. pipeline project) is
already there, documentation for it is missing.  Add the index file to
the doc tree to generate the documentation.

Change-Id: I003d235867d58d12c7bcab83c54c7eca95d32ca9
Signed-off-by: Ryo Tagami <rtagami@airstrip.jp>
2016-09-16 15:22:45 +09:00
doc Add Workflow Project Documentation 2016-09-16 15:22:45 +09:00
etc Stash publisher's credentials configuration 2015-08-24 15:23:47 +02:00
jenkins_jobs Merge "Update junit plugin" 2016-09-14 19:30:24 +00:00
samples reference tests as examples 2014-05-29 09:30:49 -07:00
tests Merge "Update junit plugin" 2016-09-14 19:30:24 +00:00
tools Remove obsolete tools script 2016-06-06 19:38:21 +00:00
.gitignore Modifying .gitignore file to add .idea folder 2015-12-21 13:40:19 +01: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
docs-requirements.txt Add a requirements file for readthedocs 2015-07-27 06:40:49 -07: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 Change documentation to install from pypi 2016-04-23 12:20:44 +00:00
requirements.txt Introduce modular implementation of subcommands. 2016-07-08 09:55:44 -07:00
setup.cfg Fix entry point name for delete-all subcommand 2016-07-19 18:57:34 +01:00
setup.py Migrate to pbr 2014-03-14 22:25:46 +01:00
test-requirements.txt Remove discover from test-requirements 2016-07-22 04:56:46 +00:00
tox.ini Introduce modular implementation of subcommands. 2016-07-08 09:55:44 -07:00

README.rst

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:

Developers

Bug report:

Repository:

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:

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