Skip to content

Commit

Permalink
adjust release event docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anbraten committed Jan 31, 2024
1 parent 8429811 commit c9375cf
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/docs/20-usage/15-terminiology/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
- `pull_request`: A pull request event is triggered when a pull request is opened or a new commit is pushed to it.
- `pull_request_closed`: A pull request closed event is triggered when a pull request is closed or merged.
- `tag`: A tag event is triggered when a tag is pushed.
- `release`: A release event is triggered when a release is created.
- `release`: A release event is triggered when a release, pre-release or draft is created. (You can apply further filters using [evaluate](../20-workflow-syntax.md#evaluate) with [environment variables](../50-environment.md#built-in-environment-variables).)
- `manual`: A manual event is triggered when a user manually triggers a pipeline.
- `cron`: A cron event is triggered when a cron job is executed.

Expand Down
6 changes: 5 additions & 1 deletion docs/docs/20-usage/20-workflow-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,10 @@ when:

### `event`

:::warning
Some events like the release event will be triggered for multiple actions like: releases, pre-releases and drafts. If you want to apply further filters checkout the [evaluate](#evaluate) filter and the available [environment variables](./50-environment.md#built-in-environment-variables).
:::

Execute a step if the build event is a `tag`:

```yaml
Expand All @@ -783,7 +787,7 @@ Execute a step for all build events:

```yaml
when:
event: [push, pull_request, tag, deployment]
event: [push, pull_request, pull_request_closed, tag, deployment, release]
```

### `ref`
Expand Down

0 comments on commit c9375cf

Please sign in to comment.