From c919f32e0b6432a95e1a6d3d0ad662f591adf73f Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sun, 4 Jun 2023 12:13:32 +0200 Subject: [PATCH] [Docs] Remove never implemented "tag"-filter and document "ref"-filter to do the same (#1820) close #1211 --- docs/docs/20-usage/20-pipeline-syntax.md | 8 ++++---- .../version-0.15/20-usage/22-conditional-execution.md | 9 --------- 2 files changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/docs/20-usage/20-pipeline-syntax.md b/docs/docs/20-usage/20-pipeline-syntax.md index fbe6c010d..e60c14910 100644 --- a/docs/docs/20-usage/20-pipeline-syntax.md +++ b/docs/docs/20-usage/20-pipeline-syntax.md @@ -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` diff --git a/docs/versioned_docs/version-0.15/20-usage/22-conditional-execution.md b/docs/versioned_docs/version-0.15/20-usage/22-conditional-execution.md index 34882014b..81e5f0093 100644 --- a/docs/versioned_docs/version-0.15/20-usage/22-conditional-execution.md +++ b/docs/versioned_docs/version-0.15/20-usage/22-conditional-execution.md @@ -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: