Skip to content

Commit

Permalink
enhance(stage): explain needs and name relationship (#400)
Browse files Browse the repository at this point in the history
Co-authored-by: Easton Crupper <[email protected]>
Co-authored-by: David May <[email protected]>
  • Loading branch information
3 people authored Apr 22, 2024
1 parent 6f8f7da commit 8a196f4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions content/tour/stages.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ stages:
- echo "Goodbye, World"
```
{{% alert title="Note:" color="info" %}}
Be aware that `needs:` references stages by their name, which can be overridden by the `name` tag in the stage definition.
{{% /alert %}}

```sh
$ vela exec pipeline
...
Expand Down
4 changes: 4 additions & 0 deletions content/usage/stage_orchestration.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ stages:
- echo $VELA_REPO_FULL_NAME
```

{{% alert title="Note:" color="info" %}}
Be aware that `needs:` references stages by their name, which can be overridden by the `name` tag in the stage definition.
{{% /alert %}}

Consider a Vela build triggered by a `push` to `main`. We know that `run-first` will indeed run first, followed by `runtime-ruleset-stage` since it cannot be pruned due to its runtime rule. However, if we recall from our first example, when the _entirety_ of a stage's step collection is pruned at compile-time, the stage disappears completely:

```yaml
Expand Down

0 comments on commit 8a196f4

Please sign in to comment.