[Docs] Fix schema to replace "tag" by "ref"-filter (#1841)

#1820 followup
This commit is contained in:
6543 2023-06-09 12:43:12 +02:00 committed by GitHub
parent 3158980d3e
commit 7bae68758f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 12 deletions

View file

@ -347,15 +347,15 @@ when:
[Read more about cron](./45-cron.md)
#### `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**:
```yaml
when:
- event: tag
tag: v*
event: tag
ref: refs/tags/v*
```
#### `status`
@ -834,7 +834,7 @@ when:
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
```yaml
when:
event: tag
ref: refs/tags/v*

View file

@ -27,12 +27,12 @@ steps:
when:
event: [push, pull_request, tag, deployment]
when-tag:
when-ref:
image: alpine
commands:
- echo "test"
when:
tag: "v**"
ref: "refs/tags/v**"
when-status:
image: alpine

View file

@ -139,8 +139,8 @@
}
]
},
"tag": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#tag",
"ref": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#ref",
"type": "string"
},
"cron": {
@ -289,8 +289,8 @@
}
]
},
"tag": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#tag",
"ref": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#ref",
"type": "string"
},
"cron": {