Skip to content

Commit b196a90

Browse files
committed
build
1 parent 67cb8d0 commit b196a90

6 files changed

Lines changed: 734 additions & 930 deletions

File tree

docs/jobs/index.html

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2303,6 +2303,18 @@
23032303

23042304
</li>
23052305

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+
23062318
<li class="md-nav__item">
23072319
<a href="#on_success" class="md-nav__link">
23082320
<span class="md-ellipsis">
@@ -2361,6 +2373,11 @@
23612373
</ul>
23622374
</nav>
23632375

2376+
</li>
2377+
2378+
</ul>
2379+
</nav>
2380+
23642381
</li>
23652382

23662383
<li class="md-nav__item">
@@ -6024,6 +6041,18 @@
60246041

60256042
</li>
60266043

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+
60276056
<li class="md-nav__item">
60286057
<a href="#on_success" class="md-nav__link">
60296058
<span class="md-ellipsis">
@@ -6082,6 +6111,11 @@
60826111
</ul>
60836112
</nav>
60846113

6114+
</li>
6115+
6116+
</ul>
6117+
</nav>
6118+
60856119
</li>
60866120

60876121
<li class="md-nav__item">
@@ -6221,25 +6255,20 @@ <h3 id="steps"><code>steps</code></h3>
62216255
<details class="info">
62226256
<summary><strong><code>old_name</code></strong>: <a href="../config-basics/#identifier-schema"><code>identifier</code></a></summary>
62236257
<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>
62296259
<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>
62306260
</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>
62316261
</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>
62326262
</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>
62336263
</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>
62346264
</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>
62366266
<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>
62376267
</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>
62386268
</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>
62396269
</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>
62406270
</span></code></pre></div>
62416271
</details>
6242-
</details>
62436272
<details class="info">
62446273
<summary><strong><code>serial</code></strong>: <a href="../config-basics/#boolean-schema"><code>boolean</code></a></summary>
62456274
<h3 id="serial"><code>serial</code></h3>
@@ -6350,36 +6379,38 @@ <h3 id="interruptible"><code>interruptible</code></h3>
63506379
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.
63516380
You may want this if you have a self-deploying Concourse or long-running-but-low-importance jobs.</p>
63526381
</details>
6382+
<h3 id="job-hooks">Job Hooks</h3>
63536383
<details class="info">
63546384
<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>
63566386
<p>Step to execute when the job succeeds. Equivalent to the <a href="../steps/modifier-and-hooks/on-success/"><code>on_success</code></a>
63576387
hook.</p>
63586388
</details>
63596389
<details class="info">
63606390
<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>
63626392
<p>Step to execute when the job fails. Equivalent to the <a href="../steps/modifier-and-hooks/on-failure/"><code>on_failure</code></a>
63636393
hook.</p>
63646394
</details>
63656395
<details class="info">
63666396
<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>
63686398
<p>Step to execute when the job errors. Equivalent to the <a href="../steps/modifier-and-hooks/on-error/"><code>on_error</code></a>
63696399
hook.</p>
63706400
</details>
63716401
<details class="info">
63726402
<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>
63746404
<p>Step to execute when the job aborts. Equivalent to the <a href="../steps/modifier-and-hooks/on-abort/"><code>on_abort</code></a>
63756405
hook.</p>
63766406
</details>
63776407
<details class="info">
63786408
<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>
63806410
<p>Step to execute regardless of whether the job succeeds, fails, errors, or aborts. Equivalent to the
63816411
<a href="../steps/modifier-and-hooks/ensure/"><code>ensure</code></a> hook.</p>
63826412
</details>
6413+
<hr>
63836414
<h2 id="managing-jobs">Managing Jobs</h2>
63846415
<h3 id="fly-jobs"><code>fly jobs</code></h3>
63856416
<p>To list the jobs configured in a pipeline, run:</p>

0 commit comments

Comments
 (0)