Skip to content
This repository has been archived by the owner on Jan 27, 2025. It is now read-only.

chore(docs): add instance to ruleset #428

Merged
merged 2 commits into from
Oct 2, 2024
Merged
Changes from all commits
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
37 changes: 26 additions & 11 deletions content/reference/yaml/steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,17 +116,18 @@ steps:

The following rules can be used to configure a ruleset:

| Name | Description |
|-----------|----------------------------------------------------|
| `branch` | name of branch for a build. |
| `comment` | pull request comment body. |
| `event` | name of an event for a build. |
| `label` | pull request label. |
| `path` | path to workspace files for a build. |
| `repo` | name of the repo for a build. |
| `status` | name of status for a build. |
| `tag` | name of reference for a build. |
| `target` | name of deployment or schedule target for a build. |
| Name | Description |
|------------|----------------------------------------------------|
| `branch` | name of branch for a build. |
| `comment` | pull request comment body. |
| `event` | name of an event for a build. |
| `instance` | FQDN of backend server instance. |
| `label` | pull request label. |
| `path` | path to workspace files for a build. |
| `repo` | name of the repo for a build. |
| `status` | name of status for a build. |
| `tag` | name of reference for a build. |
| `target` | name of deployment or schedule target for a build. |

```yaml
---
Expand Down Expand Up @@ -185,6 +186,20 @@ If you wish to include _all_ event types from an event, you can specify a wildca

{{% /alert %}}

```yaml
---
steps:
- name: Limiting execution to an instance
ruleset:
# This step will execute if the FQDN of the
# server backend instance matches the supplied value.
instance: https://vela-server.example.com
```

{{% alert color="info" %}}
Ensure you are supplying the address of the configured backend server and not the web UI.
{{% /alert %}}

```yaml
---
steps:
Expand Down
Loading