Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 3 commits into from
Jun 4, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a03a5a
remove never implemented filter "tag" from docs
6543 Jun 3, 2023
65eb442
Document ref filter and how it can be used to filter tags
6543 Jun 3, 2023
9e2c0e0
Merge branch 'master' into fix_docu_rm-tag-filter
6543 Jun 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/docs/20-usage/20-pipeline-syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
9 changes: 0 additions & 9 deletions docs/versioned_docs/version-0.15/20-usage/22-conditional-execution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down