Document tag_filter source parameter.
This commit is contained in:
16
README.md
16
README.md
@@ -42,6 +42,11 @@ Fetches and creates versioned GitHub resources.
|
|||||||
will be detected and published. Note that releases must have semver compliant
|
will be detected and published. Note that releases must have semver compliant
|
||||||
tags to be detected, even if they're drafts.
|
tags to be detected, even if they're drafts.
|
||||||
|
|
||||||
|
* `tag_filter`: *Optional. If set, override default tag filter regular
|
||||||
|
expression of `v?([^v].*)`. If the filter includes a capture group, the capture
|
||||||
|
group is used as the release version; otherwise, the entire matching substring
|
||||||
|
is used as the version.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
@@ -74,6 +79,17 @@ To get a specific version of a release:
|
|||||||
version: { tag: 'v0.0.1' }
|
version: { tag: 'v0.0.1' }
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To set a custom tag filter:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: gh-release
|
||||||
|
type: github-release
|
||||||
|
source:
|
||||||
|
owner: concourse
|
||||||
|
repository: concourse
|
||||||
|
tag_filter: "version-(.*)"
|
||||||
|
```
|
||||||
|
|
||||||
## Behavior
|
## Behavior
|
||||||
|
|
||||||
### `check`: Check for released versions.
|
### `check`: Check for released versions.
|
||||||
|
|||||||
Reference in New Issue
Block a user