|
2303 | 2303 |
|
2304 | 2304 | </li> |
2305 | 2305 |
|
| 2306 | + <li class="md-nav__item"> |
| 2307 | + <a href="#job-hooks" class="md-nav__link"> |
| 2308 | + <span class="md-ellipsis"> |
| 2309 | + |
| 2310 | + Job Hooks |
| 2311 | + |
| 2312 | + </span> |
| 2313 | + </a> |
| 2314 | + |
| 2315 | + <nav class="md-nav" aria-label="Job Hooks"> |
| 2316 | + <ul class="md-nav__list"> |
| 2317 | + |
2306 | 2318 | <li class="md-nav__item"> |
2307 | 2319 | <a href="#on_success" class="md-nav__link"> |
2308 | 2320 | <span class="md-ellipsis"> |
|
2361 | 2373 | </ul> |
2362 | 2374 | </nav> |
2363 | 2375 |
|
| 2376 | +</li> |
| 2377 | + |
| 2378 | + </ul> |
| 2379 | + </nav> |
| 2380 | + |
2364 | 2381 | </li> |
2365 | 2382 |
|
2366 | 2383 | <li class="md-nav__item"> |
|
6024 | 6041 |
|
6025 | 6042 | </li> |
6026 | 6043 |
|
| 6044 | + <li class="md-nav__item"> |
| 6045 | + <a href="#job-hooks" class="md-nav__link"> |
| 6046 | + <span class="md-ellipsis"> |
| 6047 | + |
| 6048 | + Job Hooks |
| 6049 | + |
| 6050 | + </span> |
| 6051 | + </a> |
| 6052 | + |
| 6053 | + <nav class="md-nav" aria-label="Job Hooks"> |
| 6054 | + <ul class="md-nav__list"> |
| 6055 | + |
6027 | 6056 | <li class="md-nav__item"> |
6028 | 6057 | <a href="#on_success" class="md-nav__link"> |
6029 | 6058 | <span class="md-ellipsis"> |
|
6082 | 6111 | </ul> |
6083 | 6112 | </nav> |
6084 | 6113 |
|
| 6114 | +</li> |
| 6115 | + |
| 6116 | + </ul> |
| 6117 | + </nav> |
| 6118 | + |
6085 | 6119 | </li> |
6086 | 6120 |
|
6087 | 6121 | <li class="md-nav__item"> |
@@ -6221,25 +6255,20 @@ <h3 id="steps"><code>steps</code></h3> |
6221 | 6255 | <details class="info"> |
6222 | 6256 | <summary><strong><code>old_name</code></strong>: <a href="../config-basics/#identifier-schema"><code>identifier</code></a></summary> |
6223 | 6257 | <h3 id="old_name"><code>old_name</code></h3> |
6224 | | -<p>The old name of the job. If configured, the history of old job will be inherited to the new one. Once the pipeline |
6225 | | -is set, this field can be removed as the builds have been transfered.</p> |
6226 | | -<details class="example"> |
6227 | | -<summary>Renaming a job</summary> |
6228 | | -<p>This can be used to rename a job without losing its history, like so:</p> |
| 6258 | +<p>The old name of the job. This can be used to rename a job without losing its history, like so:</p> |
6229 | 6259 | <div class="language-yaml highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">jobs</span><span class="p">:</span> |
6230 | 6260 | </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">new-name</span> |
6231 | 6261 | </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">old_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">current-name</span> |
6232 | 6262 | </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">plan</span><span class="p">:</span> |
6233 | 6263 | </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">get</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span> |
6234 | 6264 | </span></code></pre></div> |
6235 | | -<p>After the pipeline is set, because the builds have been inherited, the job can have the field removed:</p> |
| 6265 | +<p>After the pipeline is set, because the builds have been transferred, the job can have the field removed:</p> |
6236 | 6266 | <div class="language-yaml highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">jobs</span><span class="p">:</span> |
6237 | 6267 | </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">new-name</span> |
6238 | 6268 | </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">plan</span><span class="p">:</span> |
6239 | 6269 | </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">get</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span> |
6240 | 6270 | </span></code></pre></div> |
6241 | 6271 | </details> |
6242 | | -</details> |
6243 | 6272 | <details class="info"> |
6244 | 6273 | <summary><strong><code>serial</code></strong>: <a href="../config-basics/#boolean-schema"><code>boolean</code></a></summary> |
6245 | 6274 | <h3 id="serial"><code>serial</code></h3> |
@@ -6350,36 +6379,38 @@ <h3 id="interruptible"><code>interruptible</code></h3> |
6350 | 6379 | worker to finish before exiting. If this value is set to <code>true</code>, the worker will not wait on the builds of this job. |
6351 | 6380 | You may want this if you have a self-deploying Concourse or long-running-but-low-importance jobs.</p> |
6352 | 6381 | </details> |
| 6382 | +<h3 id="job-hooks">Job Hooks</h3> |
6353 | 6383 | <details class="info"> |
6354 | 6384 | <summary><code>on_success</code>: <a href="../steps/"><code>step</code></a></summary> |
6355 | | -<h3 id="on_success"><code>on_success</code></h3> |
| 6385 | +<h4 id="on_success"><code>on_success</code></h4> |
6356 | 6386 | <p>Step to execute when the job succeeds. Equivalent to the <a href="../steps/modifier-and-hooks/on-success/"><code>on_success</code></a> |
6357 | 6387 | hook.</p> |
6358 | 6388 | </details> |
6359 | 6389 | <details class="info"> |
6360 | 6390 | <summary><code>on_failure</code>: <a href="../steps/"><code>step</code></a></summary> |
6361 | | -<h3 id="on_failure"><code>on_failure</code></h3> |
| 6391 | +<h4 id="on_failure"><code>on_failure</code></h4> |
6362 | 6392 | <p>Step to execute when the job fails. Equivalent to the <a href="../steps/modifier-and-hooks/on-failure/"><code>on_failure</code></a> |
6363 | 6393 | hook.</p> |
6364 | 6394 | </details> |
6365 | 6395 | <details class="info"> |
6366 | 6396 | <summary><code>on_error</code>: <a href="../steps/"><code>step</code></a></summary> |
6367 | | -<h3 id="on_error"><code>on_error</code></h3> |
| 6397 | +<h4 id="on_error"><code>on_error</code></h4> |
6368 | 6398 | <p>Step to execute when the job errors. Equivalent to the <a href="../steps/modifier-and-hooks/on-error/"><code>on_error</code></a> |
6369 | 6399 | hook.</p> |
6370 | 6400 | </details> |
6371 | 6401 | <details class="info"> |
6372 | 6402 | <summary><code>on_abort</code>: <a href="../steps/"><code>step</code></a></summary> |
6373 | | -<h3 id="on_abort"><code>on_abort</code></h3> |
| 6403 | +<h4 id="on_abort"><code>on_abort</code></h4> |
6374 | 6404 | <p>Step to execute when the job aborts. Equivalent to the <a href="../steps/modifier-and-hooks/on-abort/"><code>on_abort</code></a> |
6375 | 6405 | hook.</p> |
6376 | 6406 | </details> |
6377 | 6407 | <details class="info"> |
6378 | 6408 | <summary><code>ensure</code>: <a href="../steps/"><code>step</code></a></summary> |
6379 | | -<h3 id="ensure"><code>ensure</code></h3> |
| 6409 | +<h4 id="ensure"><code>ensure</code></h4> |
6380 | 6410 | <p>Step to execute regardless of whether the job succeeds, fails, errors, or aborts. Equivalent to the |
6381 | 6411 | <a href="../steps/modifier-and-hooks/ensure/"><code>ensure</code></a> hook.</p> |
6382 | 6412 | </details> |
| 6413 | +<hr> |
6383 | 6414 | <h2 id="managing-jobs">Managing Jobs</h2> |
6384 | 6415 | <h3 id="fly-jobs"><code>fly jobs</code></h3> |
6385 | 6416 | <p>To list the jobs configured in a pipeline, run:</p> |
|
0 commit comments