jjb
/
jenkins-job-builder
Code Issues Proposed changes

Document node parameter usage with matrix projects 

The Matrix Tie Parent plugin has been deprecated for a while and the
documentation for it in JJB mentions that it's deprecated, but the
documentation doesn't call out how to use the new way of doing it.  This
patch updates the documentation to explicitly call out that the node
parameter only controls the matrix job's parent job.

Change-Id: Ie784f6d90667a0bc66ae0efd3eda1974ddbac4f2
This commit is contained in:
Clayton O'Neill 2014-11-24 15:34:00 -05:00
parent 307343bf10
commit db9d51ac86
3 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
jenkins_jobs/modules/general.py
View File

@ -82,8 +82,9 @@ Example:
* **node**:
Restrict where this job can be run. If there is a group of
machines that the job can be built on, you can specify that
label as the node to tie on, which will cause Jenkins to build
the job on any of the machines with that label.
label as the node to tie on, which will cause Jenkins to build the job on
any of the machines with that label. For matrix projects, this parameter
will only restrict where the parent job will run.
* **logrotate**:
The Logrotate section allows you to automatically remove old build

4
jenkins_jobs/modules/project_matrix.py
View File

@ -31,6 +31,10 @@ The module supports also dynamic axis:
Requires the Jenkins `dynamic axis Plugin.
<https://wiki.jenkins-ci.org/display/JENKINS/DynamicAxis+Plugin>`_
To tie the parent job to a specific node, you should use ``node`` parameter.
On a matrix project, this will tie *only* the parent job. To restrict axes
jobs, you can define a single value ``slave`` axis.
:Job Parameters:
* **execution-strategy** (optional):
* **combination-filter** (`str`): axes selection filter

2
jenkins_jobs/modules/wrappers.py
View File

@ -1061,6 +1061,8 @@ def matrix_tie_parent(parser, xml_parent, data):
<https://wiki.jenkins-ci.org/display/JENKINS/Matrix+Tie+Parent+Plugin>`_
Note that from Jenkins version 1.532 this plugin's functionality is
available under the "advanced" option of the matrix project configuration.
You can use the top level ``node`` parameter to control where the parent
job is tied in Jenkins 1.532 and higher.
:arg str node: Name of the node.