From 2d1494d3a3e996da8d734fbc2e6b209c2d3ba477 Mon Sep 17 00:00:00 2001 From: Khai Do Date: Wed, 28 May 2014 16:15:16 -0700 Subject: [PATCH] remove misleading jjb example Change I059f38d0aa8a8947aaac75e0ddb34d392063ece3 added support for passing parameters to jobs in groups but not for variable substitution on those parameters. Substitution on job list parameters would be a new feature. This change removes a misleading parameter subsitution example. Partial-bug: #1298568 Change-Id: I18e28bb622f0473f049963ce6dcf6c4efd11dc2c --- doc/source/configuration.rst | 47 +++++++++++------------------------- 1 file changed, 14 insertions(+), 33 deletions(-) diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index f7a516b5a..6dab4bd3c 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -152,7 +152,14 @@ with those values. The example above would create the job called The ``jobs:`` list can also allow for specifying job-specific substitutions as follows:: -.. literalinclude:: /../../tests/yamlparser/fixtures/templates001.yaml + - project: + name: project-name + jobs: + - '{name}-unit-tests': + mail-to: developer@nowhere.net + - '{name}-perf-tests': + mail-to: projmanager@nowhere.net + If a variable is a list, the job template will be realized with the variable set to each value in the list. Multiple lists will lead to @@ -162,10 +169,10 @@ values. Example:: - project: name: project-name pyver: - - 26 - - 27 + - 26 + - 27 jobs: - - '{name}-{pyver}' + - '{name}-{pyver}' Job Group ^^^^^^^^^ @@ -173,39 +180,13 @@ Job Group If you have several Job Templates that should all be realized together, you can define a Job Group to collect them. Simply use the Job Group where you would normally use a `Job Template`_ and all of -the Job Templates in the Job Group will be realized. For example:: +the Job Templates in the Job Group will be realized. For example: - - job-template: - name: '{name}-python-26' +.. literalinclude:: /../../tests/yamlparser/fixtures/templates001.yaml - - job-template: - name: '{name}-python-27' - - - job-group: - name: python-jobs - jobs: - - '{name}-python-26' - - '{name}-python-27' - - - project: - name: foo - jobs: - - python-jobs - -Would cause the jobs `foo-python-26` and `foo-python-27` to be created +Would cause the jobs `project-name-unit-tests` and `project-name-perf-tests` to be created in Jenkins. -The ``jobs:`` list can also allow for specifying job-specific -substitutions as follows:: - - - job-group: - name: job-group-name - jobs: - - '{name}-build': - pipeline-next: '{name}-upload' - - '{name}-upload': - pipeline-next: '' - .. _macro: Macro