jenkins-job-builder 0.5.0-2 / usr / share / doc / jenkins-job-builder / html / builders.html

This file is indexed.

/usr/share/doc/jenkins-job-builder/html/builders.html is in jenkins-job-builder 0.5.0-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Builders &mdash; Jenkins Job Builder 0.0.0 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '0.0.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="Jenkins Job Builder 0.0.0 documentation" href="index.html" />
    <link rel="up" title="Configuration" href="configuration.html" />
    <link rel="next" title="Hipchat" href="hipchat.html" />
    <link rel="prev" title="General Job Configuration" href="general.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="hipchat.html" title="Hipchat"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="general.html" title="General Job Configuration"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Jenkins Job Builder 0.0.0 documentation</a> &raquo;</li>
          <li><a href="configuration.html" accesskey="U">Configuration</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="builders">
<span id="id1"></span><h1>Builders<a class="headerlink" href="#builders" title="Permalink to this headline"></a></h1>
<span class="target" id="module-builders"></span><p>Builders define actions that the Jenkins job should execute.  Examples
include shell scripts or maven targets.  The <tt class="docutils literal"><span class="pre">builders</span></tt> attribute in
the <a class="reference internal" href="configuration.html#job"><em>Job</em></a> definition accepts a list of builders to invoke.  They
may be components defined below, locally defined macros (using the top
level definition of <tt class="docutils literal"><span class="pre">builder:</span></tt>, or locally defined components found
via the <tt class="docutils literal"><span class="pre">jenkins_jobs.builders</span></tt> entry point.</p>
<dl class="docutils">
<dt><strong>Component</strong>: builders</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Macro:</th><td class="field-body">builder</td>
</tr>
<tr class="field-even field"><th class="field-name">Entry Point:</th><td class="field-body">jenkins_jobs.builders</td>
</tr>
</tbody>
</table>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>job:
  name: test_job

  builders:
    - shell: &quot;make test&quot;
</pre></div>
</div>
<dl class="yamlfunction">
<dt id="builders.ant">
<tt class="descname">ant</tt><a class="headerlink" href="#builders.ant" title="Permalink to this definition"></a></dt>
<dd><p>Execute an ant target.  Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Ant+Plugin">Ant Plugin.</a></p>
<p>To setup this builder you can either reference the list of targets
or use named parameters. Below is a description of both forms:</p>
<p><em>1) Listing targets:</em></p>
<p>After the ant directive, simply pass as argument a space separated list
of targets to build.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameter:</th><td class="field-body">space separated list of Ant targets</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ant-name</strong> (<em>str</em>) &#8211; the name of the ant installation,
defaults to &#8216;default&#8217; (optional)</td>
</tr>
</tbody>
</table>
<p>Example to call two Ant targets:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - ant: &quot;target1 target2&quot;
     ant-name: &quot;Standard Ant&quot;
</pre></div>
</div>
<p>The build file would be whatever the Jenkins Ant Plugin is set to use
per default (i.e build.xml in the workspace root).</p>
<p><em>2) Using named parameters:</em></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>targets</strong> (<em>str</em>) &#8211; the space separated list of ANT targets.</li>
<li><strong>buildfile</strong> (<em>str</em>) &#8211; the path to the ANT build file.</li>
<li><strong>properties</strong> (<em>list</em>) &#8211; Passed to ant script using -Dkey=value (optional)</li>
<li><strong>ant-name</strong> (<em>str</em>) &#8211; the name of the ant installation,
defaults to &#8216;default&#8217; (optional)</li>
<li><strong>java-opts</strong> (<em>str</em>) &#8211; java options for ant, can have multiples,
must be in quotes (optional)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example specifying the build file too and several targets:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - ant:
     targets: &quot;debug test install&quot;
     buildfile: &quot;build.xml&quot;
     properties:
        builddir: &quot;/tmp/&quot;
        failonerror: true
     java-opts:
        - &quot;-ea&quot;
        - &quot;-Xmx512m&quot;
     ant-name: &quot;Standard Ant&quot;
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.artifact-resolver">
<tt class="descname">artifact-resolver</tt><a class="headerlink" href="#builders.artifact-resolver" title="Permalink to this definition"></a></dt>
<dd><p>Allows one to resolve artifacts from a maven repository like nexus
(without having maven installed)
Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Repository+Connector+Plugin">Repository Connector Plugin</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>fail-on-error</strong> (<em>bool</em>) &#8211; Whether to fail the build on error (default false)</li>
<li><strong>repository-logging</strong> (<em>bool</em>) &#8211; Enable repository logging (default false)</li>
<li><strong>target-directory</strong> (<em>str</em>) &#8211; Where to resolve artifacts to</li>
<li><strong>artifacts</strong> (<em>list</em>) &#8211; <p>list of artifacts to resolve</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Artifact:</th><td class="field-body"><ul class="first last">
<li><strong>group-id</strong> (<cite>str</cite>) &#8211; Group ID of the artifact</li>
<li><strong>artifact-id</strong> (<cite>str</cite>) &#8211; Artifact ID of the artifact</li>
<li><strong>version</strong> (<cite>str</cite>) &#8211; Version of the artifact</li>
<li><strong>classifier</strong> (<cite>str</cite>) &#8211; Classifier of the artifact
(default &#8216;&#8217;)</li>
<li><strong>extension</strong> (<cite>str</cite>) &#8211; Extension of the artifact
(default &#8216;jar&#8217;)</li>
<li><strong>target-file-name</strong> (<cite>str</cite>) &#8211; What to name the artifact
(default &#8216;&#8217;)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - artifact-resolver:
      fail-on-error: true
      repository-logging: true
      target-directory: foo
      artifacts:
        - group-id: commons-logging
          artifact-id: commons-logging
          version: 1.1
          classifier: src
          extension: jar
          target-file-name: comm-log.jar
        - group-id: commons-lang
          artifact-id: commons-lang
          version: 1.2
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.batch">
<tt class="descname">batch</tt><a class="headerlink" href="#builders.batch" title="Permalink to this definition"></a></dt>
<dd><p>Execute a batch command.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameter:</th><td class="field-body">the batch command to execute</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - batch: &quot;foo/foo.bat&quot;
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.builders-from">
<tt class="descname">builders-from</tt><a class="headerlink" href="#builders.builders-from" title="Permalink to this definition"></a></dt>
<dd><p>Use builders from another project.
Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Template+Project+Plugin">Template Project Plugin.</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>projectName</strong> (<em>str</em>) &#8211; the name of the other project</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - builders-from:
      - project: &quot;base-build&quot;
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.conditional-step">
<tt class="descname">conditional-step</tt><a class="headerlink" href="#builders.conditional-step" title="Permalink to this definition"></a></dt>
<dd><p>Conditionaly execute some build steps.  Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Conditional+BuildStep+Plugin">Conditional
BuildStep Plugin</a>.</p>
<p>Depending on the number of declared steps, a <cite>Conditional step (single)</cite>
or a <cite>Conditional steps (multiple)</cite> is created in Jenkins.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>condition-kind</strong> (<em>str</em>) &#8211; Condition kind that must be verified before the
steps are executed. Valid values and their additional attributes are
described in the <a class="reference internal" href="#conditions">conditions</a> table.</li>
<li><strong>on-evaluation-failure</strong> (<em>str</em>) &#8211; What should be the outcome of the build
if the evaluation of the condition fails. Possible values are <cite>fail</cite>,
<cite>mark-unstable</cite>, <cite>run-and-mark-unstable</cite>, <cite>run</cite> and <cite>dont-run</cite>.
Default is <cite>fail</cite>.</li>
<li><strong>steps</strong> (<em>list</em>) &#8211; List of steps to run if the condition is verified. Items
in the list can be any builder known by Jenkins Job Builder.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<table border="1" class="docutils" id="conditions">
<colgroup>
<col width="26%" />
<col width="74%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Condition kind</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>always</td>
<td>Condition is always verified</td>
</tr>
<tr class="row-odd"><td>never</td>
<td>Condition is never verified</td>
</tr>
<tr class="row-even"><td>boolean-expression</td>
<td><p class="first">Run the step if the expression expends to a
representation of true</p>
<blockquote class="last">
<div><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">condition-expression:</th></tr>
<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Expression to expand</td>
</tr>
</tbody>
</table>
</div></blockquote>
</td>
</tr>
<tr class="row-odd"><td>current-status</td>
<td><p class="first">Run the build step if the current build status is
within the configured range</p>
<blockquote class="last">
<div><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">condition-worst:</th></tr>
<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Worst status</td>
</tr>
<tr class="field-even field"><th class="field-name">condition-best:</th><td class="field-body">Best status</td>
</tr>
</tbody>
</table>
</div></blockquote>
</td>
</tr>
<tr class="row-even"><td>shell</td>
<td><p class="first">Run the step if the shell command succeed</p>
<blockquote class="last">
<div><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">condition-command:</th></tr>
<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Shell command to execute</td>
</tr>
</tbody>
</table>
</div></blockquote>
</td>
</tr>
<tr class="row-odd"><td>windows-shell</td>
<td><p class="first">Similar to shell, except that commands will be
executed by cmd, under Windows</p>
<blockquote class="last">
<div><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">condition-command:</th></tr>
<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Command to execute</td>
</tr>
</tbody>
</table>
</div></blockquote>
</td>
</tr>
<tr class="row-even"><td>file-exists</td>
<td><p class="first">Run the step if a file exists</p>
<blockquote class="last">
<div><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">condition-filename:</th></tr>
<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Check existence of this file</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">condition-basedir:</th></tr>
<tr class="field-even field"><td>&nbsp;</td><td class="field-body">If condition-filename is
relative, it will be considered relative to
either <cite>workspace</cite>, <cite>artifact-directory</cite>,
or <cite>jenkins-home</cite>. Default is <cite>workspace</cite>.</td>
</tr>
</tbody>
</table>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - conditional-step:
      condition-kind: boolean-expression
      condition-expression: &quot;${ENV,var=IS_STABLE_BRANCH}&quot;
      on-evaluation-failure: mark-unstable
      steps:
          - shell: &quot;echo Making extra checks&quot;
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.copyartifact">
<tt class="descname">copyartifact</tt><a class="headerlink" href="#builders.copyartifact" title="Permalink to this definition"></a></dt>
<dd><p>Copy artifact from another project.  Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Copy+Artifact+Plugin">Copy Artifact
plugin.</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>project</strong> (<em>str</em>) &#8211; Project to copy from</li>
<li><strong>filter</strong> (<em>str</em>) &#8211; what files to copy</li>
<li><strong>target</strong> (<em>str</em>) &#8211; Target base directory for copy, blank means use workspace</li>
<li><strong>flatten</strong> (<em>bool</em>) &#8211; Flatten directories (default: false)</li>
<li><strong>which-build</strong> (<em>str</em>) &#8211; which build to get artifacts from
(optional, default last-successful)</li>
<li><strong>build-number</strong> (<em>str</em>) &#8211; specifies the build number to get when
when specific-build is specified as which-build</li>
<li><strong>permalink</strong> (<em>str</em>) &#8211; specifies the permalink to get when
permalink is specified as which-build</li>
<li><strong>stable</strong> (<em>bool</em>) &#8211; specifies to get only last stable build when
last-successful is specified as which-build</li>
<li><strong>fallback-to-last-successful</strong> (<em>bool</em>) &#8211; specifies to fallback to
last successful build when upstream-build is specified as which-build</li>
<li><strong>param</strong> (<em>string</em>) &#8211; specifies to use a build parameter to get the build when
build-param is specified as which-build</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">Which-build values:</th></tr>
<tr class="field-even field"><td>&nbsp;</td><td class="field-body"><ul class="first simple">
<li><strong>last-successful</strong></li>
<li><strong>specific-build</strong></li>
<li><strong>last-saved</strong></li>
<li><strong>upstream-build</strong></li>
<li><strong>permalink</strong></li>
<li><strong>workspace-latest</strong></li>
<li><strong>build-param</strong></li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">Permalink values:</th></tr>
<tr class="field-odd field"><td>&nbsp;</td><td class="field-body"><ul class="first last simple">
<li><strong>last</strong></li>
<li><strong>last-stable</strong></li>
<li><strong>last-successful</strong></li>
<li><strong>last-failed</strong></li>
<li><strong>last-unstable</strong></li>
<li><strong>last-unsuccessful</strong></li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - copyartifact:
      project: foo
      filter: *.tar.gz
      target: /home/foo
      which-build: specific-build
      build-number: 123
      flatten: true
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.gradle">
<tt class="descname">gradle</tt><a class="headerlink" href="#builders.gradle" title="Permalink to this definition"></a></dt>
<dd><p>Execute gradle tasks.  Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Gradle+Plugin">Gradle Plugin.</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>tasks</strong> (<em>str</em>) &#8211; List of tasks to execute</li>
<li><strong>gradle-name</strong> (<em>str</em>) &#8211; Use a custom gradle name (optional)</li>
<li><strong>wrapper</strong> (<em>bool</em>) &#8211; use gradle wrapper (default false)</li>
<li><strong>executable</strong> (<em>bool</em>) &#8211; make gradlew executable (default false)</li>
<li><strong>switches</strong> (<em>list</em>) &#8211; Switches for gradle, can have multiples</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - gradle:
      gradle-name: &quot;gradle-1.2&quot;
      wrapper: true
      executable: true
      switches:
        - &quot;-g /foo/bar/.gradle&quot;
        - &quot;-PmavenUserName=foobar&quot;
      tasks: |
             init
             build
             tests
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.grails">
<tt class="descname">grails</tt><a class="headerlink" href="#builders.grails" title="Permalink to this definition"></a></dt>
<dd><p>Execute a grails build step. Requires the <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Grails+Plugin">Jenkins Grails Plugin.</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>use-wrapper</strong> (<em>bool</em>) &#8211; Use a grails wrapper (default false)</li>
<li><strong>name</strong> (<em>str</em>) &#8211; Select a grails installation to use (optional)</li>
<li><strong>force-upgrade</strong> (<em>bool</em>) &#8211; Run &#8216;grails upgrade &#8211;non-interactive&#8217;
first (default false)</li>
<li><strong>non-interactive</strong> (<em>bool</em>) &#8211; append &#8211;non-interactive to all build targets
(default false)</li>
<li><strong>targets</strong> (<em>str</em>) &#8211; Specify target(s) to run separated by spaces</li>
<li><strong>server-port</strong> (<em>str</em>) &#8211; Specify a value for the server.port system
property (optional)</li>
<li><strong>work-dir</strong> (<em>str</em>) &#8211; Specify a value for the grails.work.dir system
property (optional)</li>
<li><strong>project-dir</strong> (<em>str</em>) &#8211; Specify a value for the grails.project.work.dir
system property (optional)</li>
<li><strong>base-dir</strong> (<em>str</em>) &#8211; Specify a path to the root of the Grails
project (optional)</li>
<li><strong>properties</strong> (<em>str</em>) &#8211; Additional system properties to set (optional)</li>
<li><strong>plain-output</strong> (<em>bool</em>) &#8211; append &#8211;plain-output to all build targets
(default false)</li>
<li><strong>stack-trace</strong> (<em>bool</em>) &#8211; append &#8211;stack-trace to all build targets
(default false)</li>
<li><strong>verbose</strong> (<em>bool</em>) &#8211; append &#8211;verbose to all build targets
(default false)</li>
<li><strong>refresh-dependencies</strong> (<em>bool</em>) &#8211; append &#8211;refresh-dependencies to all
build targets (default false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - grails:
      use-wrapper: &quot;true&quot;
      name: &quot;grails-2.2.2&quot;
      force-upgrade: &quot;true&quot;
      non-interactive: &quot;true&quot;
      targets: &quot;war ear&quot;
      server-port: &quot;8003&quot;
      work-dir: &quot;./grails-work&quot;
      project-dir: &quot;./project-work&quot;
      base-dir: &quot;./grails/project&quot;
      properties: &quot;program.name=foo&quot;
      plain-output: &quot;true&quot;
      stack-trace: &quot;true&quot;
      verbose: &quot;true&quot;
      refresh-dependencies: &quot;true&quot;
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.inject">
<tt class="descname">inject</tt><a class="headerlink" href="#builders.inject" title="Permalink to this definition"></a></dt>
<dd><p>Inject an environment for the job.
Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+Plugin">EnvInject Plugin.</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>properties-file</strong> (<em>str</em>) &#8211; the name of the property file (optional)</li>
<li><strong>properties-content</strong> (<em>str</em>) &#8211; the properties content (optional)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - inject:
      properties-file: example.prop
      properties-content: EXAMPLE=foo-bar
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.maven-target">
<tt class="descname">maven-target</tt><a class="headerlink" href="#builders.maven-target" title="Permalink to this definition"></a></dt>
<dd><p>Execute top-level Maven targets</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>goals</strong> (<em>str</em>) &#8211; Goals to execute</li>
<li><strong>properties</strong> (<em>str</em>) &#8211; Properties for maven, can have multiples</li>
<li><strong>pom</strong> (<em>str</em>) &#8211; Location of pom.xml (defaults to pom.xml)</li>
<li><strong>maven-version</strong> (<em>str</em>) &#8211; Installation of maven which should be used
(optional)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - maven-target:
      maven-version: Maven3
      pom: parent/pom.xml
      goals: clean
      properties:
        - foo=bar
        - bar=foo
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.msbuild">
<tt class="descname">msbuild</tt><a class="headerlink" href="#builders.msbuild" title="Permalink to this definition"></a></dt>
<dd><p>Build .NET project using msbuild.  Requires the <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/MSBuild+Plugin">Jenkins MSBuild Plugin</a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>msbuild-version</strong> (<em>str</em>) &#8211; which msbuild configured in Jenkins to use
(optional)</li>
<li><strong>solution-file</strong> (<em>str</em>) &#8211; location of the solution file to build</li>
<li><strong>extra-parameters</strong> (<em>str</em>) &#8211; extra parameters to pass to msbuild (optional)</li>
<li><strong>pass-build-variables</strong> (<em>bool</em>) &#8211; should build variables be passed
to msbuild (defaults to true)</li>
<li><strong>continue-on-build-failure</strong> (<em>bool</em>) &#8211; should the build continue if
msbuild returns an error (defaults to false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - msbuild:
      solution-file: &quot;MySolution.sln&quot;
      msbuild-version: &quot;msbuild-4.0&quot;
      extra-parameters: &quot;/maxcpucount:4&quot;
      pass-build-variables: False
      continue-on-build-failure: True
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.multijob">
<tt class="descname">multijob</tt><a class="headerlink" href="#builders.multijob" title="Permalink to this definition"></a></dt>
<dd><p>Define a multijob phase. Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Multijob+Plugin">Multijob Plugin.</a></p>
<p>This builder may only be used in     <tt class="xref py py-class docutils literal"><span class="pre">jenkins_jobs.modules.project_multijob.MultiJob</span></tt> projects.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<em>str</em>) &#8211; MultiJob phase name</li>
<li><strong>condition</strong> (<em>str</em>) &#8211; when to trigger the other job (default &#8216;SUCCESSFUL&#8217;)</li>
<li><strong>projects</strong> (<em>list</em>) &#8211; <p>list of projects to include in the MultiJob phase</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Project:</th><td class="field-body"><ul class="first last">
<li><strong>name</strong> (<cite>str</cite>) &#8211; Project name</li>
<li><strong>current-parameters</strong> (<cite>bool</cite>) &#8211; Pass current build
parameters to the other job (default false)</li>
<li><strong>git-revision</strong> (<cite>bool</cite>) &#8211; Pass current git-revision
to the other job (default false)</li>
<li><strong>property-file</strong> (<cite>str</cite>) &#8211; Pass properties from file
to the other job (optional)</li>
<li><strong>predefined-parameters</strong> (<cite>str</cite>) &#8211; Pass predefined
parameters to the other job (optional)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - multijob:
      name: PhaseOne
      condition: SUCCESSFUL
      projects:
        - name: PhaseOneJobA
          current-parameters: true
          git-revision: true
        - name: PhaseOneJobB
          current-parameters: true
          property-file: build.props
  - multijob:
      name: PhaseTwo
      condition: UNSTABLE
      projects:
        - name: PhaseTwoJobA
          current-parameters: true
          predefined-parameters: foo=bar
        - name: PhaseTwoJobB
          current-parameters: false
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.shell">
<tt class="descname">shell</tt><a class="headerlink" href="#builders.shell" title="Permalink to this definition"></a></dt>
<dd><p>Execute a shell command.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameter:</th><td class="field-body">the shell command to execute</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - shell: &quot;make test&quot;
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="builders.trigger-builds">
<tt class="descname">trigger-builds</tt><a class="headerlink" href="#builders.trigger-builds" title="Permalink to this definition"></a></dt>
<dd><p>Trigger builds of other jobs.
Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Parameterized+Trigger+Plugin">Parameterized Trigger Plugin.</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>project</strong> (<em>str</em>) &#8211; the Jenkins project to trigger</li>
<li><strong>predefined-parameters</strong> (<em>str</em>) &#8211; key/value pairs to be passed to the job (optional)</li>
<li><strong>current-parameters</strong> (<em>bool</em>) &#8211; Whether to include the
parameters passed to the current build to the
triggered job.</li>
<li><strong>svn-revision</strong> (<em>bool</em>) &#8211; Whether to pass the svn revision
to the triggered job</li>
<li><strong>block</strong> (<em>bool</em>) &#8211; whether to wait for the triggered jobs
to finish or not (default false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>builders:
  - trigger-builds:
      - project: &quot;build_started&quot;
        predefined-parameters:
          FOO=&quot;bar&quot;
        block: true
</pre></div>
</div>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="general.html"
                        title="previous chapter">General Job Configuration</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="hipchat.html"
                        title="next chapter">Hipchat</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/builders.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="hipchat.html" title="Hipchat"
             >next</a> |</li>
        <li class="right" >
          <a href="general.html" title="General Job Configuration"
             >previous</a> |</li>
        <li><a href="index.html">Jenkins Job Builder 0.0.0 documentation</a> &raquo;</li>
          <li><a href="configuration.html" >Configuration</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Jenkins Job Builder Maintainers.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.