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

This file is indexed.

/usr/share/doc/jenkins-job-builder/html/triggers.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
<!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>Triggers &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="Wrappers" href="wrappers.html" />
    <link rel="prev" title="SCM" href="scm.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="wrappers.html" title="Wrappers"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="scm.html" title="SCM"
             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="triggers">
<span id="id1"></span><h1>Triggers<a class="headerlink" href="#triggers" title="Permalink to this headline"></a></h1>
<span class="target" id="module-triggers"></span><p>Triggers define what causes a jenkins job to start buliding.</p>
<dl class="docutils">
<dt><strong>Component</strong>: triggers</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">trigger</td>
</tr>
<tr class="field-even field"><th class="field-name">Entry Point:</th><td class="field-body">jenkins_jobs.triggers</td>
</tr>
</tbody>
</table>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>job:
  name: test_job

  triggers:
    - timed: &#39;@daily&#39;
</pre></div>
</div>
<dl class="yamlfunction">
<dt id="triggers.gerrit">
<tt class="descname">gerrit</tt><a class="headerlink" href="#triggers.gerrit" title="Permalink to this definition"></a></dt>
<dd><p>Trigger on a Gerrit event.
Requires the Jenkins <a class="reference external" href="wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger">Gerrit Trigger Plugin</a> version &gt;= 2.6.0.</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>trigger-on-patchset-uploaded-event</strong> (<em>bool</em>) &#8211; Trigger on patchset upload</li>
<li><strong>trigger-on-change-abandoned-event</strong> (<em>bool</em>) &#8211; Trigger on change abandoned.
Requires Gerrit Trigger Plugin version &gt;= 2.8.0</li>
<li><strong>trigger-on-change-merged-event</strong> (<em>bool</em>) &#8211; Trigger on change merged</li>
<li><strong>trigger-on-change-restored-event</strong> (<em>bool</em>) &#8211; Trigger on change restored.
Requires Gerrit Trigger Plugin version &gt;= 2.8.0</li>
<li><strong>trigger-on-comment-added-event</strong> (<em>bool</em>) &#8211; Trigger on comment added</li>
<li><strong>trigger-on-draft-published-event</strong> (<em>bool</em>) &#8211; Trigger on draft published
event</li>
<li><strong>trigger-on-ref-updated-event</strong> (<em>bool</em>) &#8211; Trigger on ref-updated</li>
<li><strong>trigger-approval-category</strong> (<em>str</em>) &#8211; Approval category for comment added</li>
<li><strong>trigger-approval-value</strong> (<em>int</em>) &#8211; Approval value for comment added</li>
<li><strong>override-votes</strong> (<em>bool</em>) &#8211; Override default vote values</li>
<li><strong>gerrit-build-successful-verified-value</strong> (<em>int</em>) &#8211; Successful &#8216;&#8217;Verified&#8217;&#8217;
value</li>
<li><strong>gerrit-build-failed-verified-value</strong> (<em>int</em>) &#8211; Failed &#8216;&#8217;Verified&#8217;&#8217; value</li>
<li><strong>failure-message</strong> (<em>str</em>) &#8211; Message to leave on failure</li>
<li><strong>projects</strong> (<em>list</em>) &#8211; <p>list of projects to match</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>project-compare-type</strong> (<cite>str</cite>) &#8211;  &#8216;&#8217;PLAIN&#8217;&#8216;, &#8216;&#8217;ANT&#8217;&#8217; or
&#8216;&#8217;REG_EXP&#8217;&#8216;</li>
<li><strong>project-pattern</strong> (<cite>str</cite>) &#8211; Project name pattern to match</li>
<li><strong>branch-compare-type</strong> (<cite>str</cite>) &#8211; &#8216;&#8217;PLAIN&#8217;&#8216;, &#8216;&#8217;ANT&#8217;&#8217; or
&#8216;&#8217;REG_EXP&#8217;&#8216;</li>
<li><strong>branch-pattern</strong> (<cite>str</cite>) &#8211; Branch name pattern to match</li>
<li><strong>file-paths</strong> (<cite>list</cite>) &#8211; List of file paths to match
(optional)<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">File Path:</th><td class="field-body"><ul class="first last">
<li><strong>compare-type</strong> (<cite>str</cite>) &#8211; &#8216;&#8217;PLAIN&#8217;&#8216;, &#8216;&#8217;ANT&#8217;&#8217;
or &#8216;&#8217;REG_EXP&#8217;&#8217; (optional, defaults to
&#8216;&#8217;PLAIN&#8217;&#8216;)</li>
<li><strong>pattern</strong> (<cite>str</cite>) &#8211; File path pattern to
match</li>
</ul>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</li>
<li><strong>skip-vote</strong> (<em>dict</em>) &#8211; <p>map of build outcomes for which Jenkins must skip
vote. Requires Gerrit Trigger Plugin version &gt;= 2.7.0</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">Outcome:</th><td class="field-body"><ul class="first last">
<li><strong>successful</strong> (<cite>bool</cite>)</li>
<li><strong>failed</strong> (<cite>bool</cite>)</li>
<li><strong>unstable</strong> (<cite>bool</cite>)</li>
<li><strong>notbuilt</strong> (<cite>bool</cite>)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>You may select one or more gerrit events upon which to trigger.
You must also supply at least one project and branch, optionally
more.  If you select the comment-added trigger, you should alse
indicate which approval category and value you want to trigger the
job.</p>
<p>Until version 0.4.0 of Jenkins Job Builder, camelCase keys were used to
configure Gerrit Trigger Plugin, instead of hyphenated-keys.  While still
supported, camedCase keys are deprecated and should not be used.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>triggers:
  - gerrit:
      trigger-on-comment-added-event: true
      trigger-approval-category: &#39;APRV&#39;
      trigger-approval-value: 1
      projects:
        - project-compare-type: &#39;PLAIN&#39;
          project-pattern: &#39;test-project&#39;
          branch-compare-type: &#39;ANT&#39;
          branch-pattern: &#39;**&#39;
          file-paths:
              - compare-type: ANT
                pattern: subdirectory/**
      skip-vote:
          successful: true
          failed: true
          unstable: true
          notbuilt: true
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="triggers.github">
<tt class="descname">github</tt><a class="headerlink" href="#triggers.github" title="Permalink to this definition"></a></dt>
<dd><p>Trigger a job when github repository is pushed to
Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Plugin">GitHub Plugin.</a></p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>triggers:
  - github
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="triggers.github-pull-request">
<tt class="descname">github-pull-request</tt><a class="headerlink" href="#triggers.github-pull-request" title="Permalink to this definition"></a></dt>
<dd><p>Build pull requests in github and report results
Requires the Jenkins <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin">GitHub Pull Request Builder 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>admin-list</strong> (<em>list</em>) &#8211; the users with admin rights (optional)</li>
<li><strong>cron</strong> (<em>string</em>) &#8211; cron syntax of when to run (optional)</li>
<li><strong>white-list</strong> (<em>list</em>) &#8211; users whose pull requests build (optional)</li>
<li><strong>org-list</strong> (<em>list</em>) &#8211; orgs whose users should be white listed (optional)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>triggers:
  - github-pull-request:
      admin-list:
        - user1
        - user2
      cron: * * * * *
      white-list:
        - user3
        - user4
      org-list:
        - org1
        - org2
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="triggers.pollscm">
<tt class="descname">pollscm</tt><a class="headerlink" href="#triggers.pollscm" title="Permalink to this definition"></a></dt>
<dd><p>Poll the SCM to determine if there has been a change.</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 polling interval (cron syntax)</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>triggers:
  - pollscm: &quot;\*/15 * * * \*&quot;
</pre></div>
</div>
</dd></dl>

<dl class="yamlfunction">
<dt id="triggers.timed">
<tt class="descname">timed</tt><a class="headerlink" href="#triggers.timed" title="Permalink to this definition"></a></dt>
<dd><p>Trigger builds at certain times.</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">when to run the job (cron syntax)</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre>triggers:
  - timed: &quot;@midnight&quot;
</pre></div>
</div>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="scm.html"
                        title="previous chapter">SCM</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="wrappers.html"
                        title="next chapter">Wrappers</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/triggers.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="wrappers.html" title="Wrappers"
             >next</a> |</li>
        <li class="right" >
          <a href="scm.html" title="SCM"
             >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.