[Docs] Remove never implemented "tag"-filter and document "ref"-filter to do the same (#1820)

close #1211
This commit is contained in:
6543 2023-06-04 12:13:32 +02:00 committed by GitHub
parent 79c8da2f32
commit c919f32e0b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 13 deletions

View file

@ -829,15 +829,15 @@ when:
event: [push, pull_request, tag, deployment]
```
### `tag`
### `ref`
This filter only applies to tag events.
Use glob expression to execute a step if the tag name starts with `v`:
The `ref` filter compares the git reference against which the pipeline is executed.
This allows you to filter, for example, tags that must start with **v**:
```diff
when:
event: tag
tag: v*
ref: refs/tags/v*
```
### `environment`

View file

@ -86,15 +86,6 @@ when:
event: [push, pull_request, tag, deployment]
```
## `tag`
Execute a step if the tag name starts with `release`:
```diff
when:
tag: release*
```
## `status`
There are use cases for executing pipeline steps on failure, such as sending notifications for failed pipelines. Use the status constraint to execute steps even when the pipeline fails: