jjb/jenkins-job-builder
Code Issues Proposed changes

Clarify configuration and job definition

Browse Source 
The docs was a little confusing in that used a single term 'configuration' to
referred to both the JJB global configuration and the job definitions.
This change clarifies that by changing 'configuration' in a few places
to 'job definition' to make it less confusing.

Change-Id: Ie64e7d899b793c9c8e86e51076c020640e336a40
This commit is contained in:
Khai Do 2014-08-02 08:11:54 -07:00
parent 848ce968e0
commit 3dcd906880
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/configuration.rst → doc/source/definition.rst
View File

@ -1,5 +1,5 @@
Configuration
=============
Job Definitions
===============
The job definitions for Jenkins Job Builder are kept in any number of
YAML files, in whatever way you would like to organize them. When you

2
doc/source/index.rst
View File

@ -22,7 +22,7 @@ Contents:
:maxdepth: 3
installation
configuration
definition
extending
Indices and tables

18
doc/source/installation.rst
View File

@ -105,36 +105,36 @@ Test Mode
^^^^^^^^^
Once you have a configuration defined, you can run the job builder in test mode.
If you want to run a simple test with just a single YAML configuration file
If you want to run a simple test with just a single YAML job definition file
and see the XML output on stdout::
jenkins-jobs test /path/to/foo.yaml
You can also pass JJB a directory containing multiple configuration files::
You can also pass JJB a directory containing multiple job definition files::
jenkins-jobs test /path/to/configs -o /path/to/output
jenkins-jobs test /path/to/defs -o /path/to/output
which will write XML files to the output directory for all of the jobs
defined in the configs directory.
defined in the defs directory.
Updating Jenkins
^^^^^^^^^^^^^^^^
When you're satisfied with the generated XML from the test, you can run::
jenkins-jobs update /path/to/config
jenkins-jobs update /path/to/defs
which will upload the configurations to Jenkins if needed. Jenkins Job
which will upload the job definitions to Jenkins if needed. Jenkins Job
Builder maintains, for each host, a cache [#f1]_ of previously configured jobs,
so that you can run that command as often as you like, and it will only
update the configuration in Jenkins if the defined configuration has
update the jobs configurations in Jenkins if the defined definitions has
changed since the last time it was run. Note: if you modify a job
directly in Jenkins, jenkins-jobs will not know about it and will not
update it.
To update a specific list of jobs, simply pass them as additional
arguments after the configuration path. To update Foo1 and Foo2 run::
arguments after the job definition path. To update Foo1 and Foo2 run::
jenkins-jobs update /path/to/config Foo1 Foo2
jenkins-jobs update /path/to/defs Foo1 Foo2
.. rubric:: Footnotes