[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) [Read more about cron](./45-cron.md)
#### `tag` #### `ref`
This filter only applies to tag events. The `ref` filter compares the git reference against which the pipeline is executed.
Use glob expression to execute a step if the tag name starts with `v`: This allows you to filter, for example, tags that must start with **v**:
```yaml ```yaml
when: when:
- event: tag event: tag
tag: v* ref: refs/tags/v*
``` ```
#### `status` #### `status`
@ -834,7 +834,7 @@ when:
The `ref` filter compares the git reference against which the pipeline is executed. 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**: This allows you to filter, for example, tags that must start with **v**:
```diff ```yaml
when: when:
event: tag event: tag
ref: refs/tags/v* ref: refs/tags/v*

View File

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

View File

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