Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(reference): add metadata auto_cancel documentation #386

Merged
merged 1 commit into from
Nov 14, 2023
Merged

chore(reference): add metadata auto_cancel documentation #386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 40 additions & 5 deletions content/reference/yaml/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ metadata:

## Tags

| Tag | Required | Type | Description |
|-----------------|----------|------|--------------------------------------------------------------------|
| `template` | Y | bool | Enables compiling the pipeline as a template. |
| `clone` | N | bool | Enables injecting the default clone process. |
| `render_inline` | N | bool | Enables rendering without explicitly calling within the pipeline. |
| Tag | Required | Type | Description |
|-----------------|----------|-------------|--------------------------------------------------------------------|
| `template` | Y | bool | Enables compiling the pipeline as a template. |
| `clone` | N | bool | Enables injecting the default clone process. |
| `render_inline` | N | bool | Enables rendering without explicitly calling within the pipeline. |
| `auto_cancel` | N | (see below) | Auto canceling settings for pipelines. |

### Usage

Expand Down Expand Up @@ -72,4 +73,38 @@ metadata:
# in the resulting pipeline without referencing it in stages
# or steps.
render_inline: false
```

#### The `auto_cancel` tag

| Tag | Default | Type | Description |
|------------------|----------|-------|----------------------------------------------------------------------------------------------|
| `pending` | True | bool | Pending builds will be auto canceled if qualifying build is triggered |
| `running` | False | bool | Currently running builds will be auto canceled if qualifying build is triggered |
| `default_branch` | False | bool | Pushes to the default branch will also be auto canceled if a qualifying build is triggered. |

A **qualifying build** is defined as either:
* a _push_ build with the same _branch_ as another running/pending _push_ build
* a _pull request_ build with the same _head ref_ as another running/pending _pull request_ build

These builds most often happen when a user pushes a new commit to a branch and quickly push a new commit. Using the `auto_cancel` block can help free up build space and eliminate pointless builds.

By default, auto canceling is disabled altogether. However, if `running` or `default_branch` are specified, `pending` has a default value of `true` unless specified otherwise.

```yaml
---
# pending & running will auto cancel, but not pushes to the default branch.
metadata:
auto_cancel:
running: true
```

```yaml
---
# running builds will auto cancel even if they are targeting the default branch, but pending builds will not.
metadata:
auto_cancel:
pending: false
default_branch: true
running: true
```