Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update specifications.md
  • Loading branch information
NimRegev committed May 14, 2025
commit 444ef9a506237616f17480aa5100f54b20f4d546
9 changes: 7 additions & 2 deletions _docs/pipelines/specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ The priority (override behavior) is as follows, from highest to lowest:
| `spec.mode` | The execution mode for the pipeline. Leave empty to use the default. <br>Can be one of the following:{::nomarkdown}<ul><li><code class=highlighter-rouge>sequential</code>: The default, executes the steps in the order in which they are listed.</li><li><code class=highlighter-rouge>parallel</code>: Evaluates all step conditions at the same time and executes those steps that meet the requirements in parallel. Parallel execution mode allows you to order steps in ways not possible with sequential mode.</li></ul>{:/}See [Advanced workflows for pipelines]({{site.baseurl}}/docs/pipelines/advanced-workflows/). | string | Optional |
| `spec.fail_fast` | Determines pipeline execution behavior in case of step failure. Leave empty to use the default. {::nomarkdown}<ul><li><code class="highlighter-rouge">true</code>: The default, terminates pipeline execution upon step failure. The Build status returns <code class="highlighter-rouge">Failed to execute</code>.</li><li><code class="highlighter-rouge">false</code>: Continues pipeline execution upon step failure. The Build status returns <code class="highlighter-rouge">Build completed successfully</code>. <br>To change the Build status, set <code class="highlighter-rouge">spec.strict_fail_fast</code> to <code class="highlighter-rouge">true</code>.</li></ul>{:/} | boolean | Optional |
| `spec.strict_fail_fast` | Specifies how to report the Build status when `fail_fast` is set to `false`.<br>**NOTE**:<br>Requires Runner chart v6.3.9 or higher.<br><br>You can set the Build status reporting behavior at the root-level or at the step-level for the pipeline.{::nomarkdown}<ul><li><code class="highlighter-rouge">true</code>:<ul><li>When set at the <i>root-level</i>, returns a Build status of failed when any step in the pipeline with <code class="highlighter-rouge">fail_fast=false</code> fails to execute.</li><li>When set at the <i>step-level</i>, returns a Build status of failed when any step in the pipeline with <code class="highlighter-rouge">fail_fast=false</code> and <code class="highlighter-rouge">strict_fail_fast=true</code> fails to execute.</li></ul></li><li><code class="highlighter-rouge">false</code>:<ul><li>When set at the <i>root-level</i>, returns a Build status of successful when any step in the pipeline with <code class="highlighter-rouge">fail_fast=false</code> fails to execute.</li></ul> {:/} |
| `spec.concurrency` | The maximum number of concurrent builds for the pipeline, ranging from `0`, the default, to `14`, ????or unlimited. Define the concurrency when your pipeline has only one trigger. <br>When set to `0`, freezes execution of the pipeline, switching it to maintenance mode. Use this concurrency setting to modify existing pipelines and freeze execution until you complete the changes. |integer | Optional |
| `spec.triggerConcurrency` | The maximum number of concurrent builds per trigger, ranging from `1-15`, or unlimited. Define the trigger concurrency when your pipeline has multiple triggers. | integer | Optional |
| `spec.branchConcurrency` | The maximum number of concurrent builds per branch, ranging from `1-15`, or unlimited. Define the branch concurrency when your pipeline can run builds on different branches. | integer | Optional |
| `spec.priority` | The priority of the pipeline build, determining the order in which the build is queued. The priority can range from `100` (highest priority), to `-100`(lowest priority), with `0` as the default. |
| `spec.debug.steps.phases` |The phase or stage at which the debug step should run.{::nomarkdown}<ul><li><code class="highlighter-rouge">before</code>: The step runs before the build starts.</li><li><code class="highlighter-rouge">after</code>: The step runs after the build starts.</li><li><code class="highlighter-rouge">override</code>: ???.</li></ul> {:/} |boolean | Optional |


Expand All @@ -113,6 +117,7 @@ The priority (override behavior) is as follows, from highest to lowest:




### spec.triggers

{: .table .table-bordered .table-hover}
Expand Down Expand Up @@ -141,15 +146,15 @@ The priority (override behavior) is as follows, from highest to lowest:
| `spec.triggers.gerritCIStatusLabels` | The labels indicating the CI status. | array | Optional |
| `spec.triggers.context` | The name of the Git integration to use. | string | Optional |
| `spec.triggers.concurrency` | The maximum number of concurrent builds for this trigger, and can range from `1` (the default), to `15`, or unlimited). Define the trigger concurrency when your pipeline has multiple triggers. | string | Optional |
| `spec.triggers.priority` | ?? | integer | Optional |
| `spec.triggers.priority` | The priority for the specific trigger determining the order in which the trigger is executed.<br>The priority can range from `100` (highest priority) to `-100` (lowest priority), with `0` as the default.
| integer | Optional |
| `spec.triggers.terminationPolicy` | The options that determine when to terminate the build from the pipeline. See [spec.terminationPolicy](#specterminationpolicy). | integer | Optional |







### spec.triggers.events

Trigger events depend on and are specific to every Git provider.
Expand Down