From c07488ea784cfb6479f4f02c906bae31ab9a2229 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Konrad=20H=C3=B6ffner?= Date: Fri, 26 Jul 2024 11:56:42 +0200 Subject: [PATCH] clarify tag_resolver.filter documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1667b0..aae1b5a 100644 --- a/README.md +++ b/README.md @@ -570,7 +570,7 @@ Table of descriptions for the `configuration.json` options to configure the resu | exclude_merge_branches | An array of branches to be ignored from processing as merge commits | | tag_resolver | Section to provide configuration for the tag resolving logic. Used if no `fromTag` is provided | | tag_resolver.method | Defines the method to use. Current options are: `semver`, `sort`. Default: `semver` | -| tag_resolver.filter | Defines a regex object which is used to filter out tags not matching. | +| tag_resolver.filter | Defines a regex in JavaScript format (e.g. double backslash to escape a dot `\\.`) to include all matching tags and exclude the rest. Use negative lookahead to exclude tags. For example, `api.*` will only *include* tags starting with "api", `^(?!alpha).*` will *exclude* all tags starting with "alpha".| | tag_resolver.transformer | Defines a regex transformer used to optionally transform the tag after the filter was applied. Allows to adjust the format to e.g. semver. | | base_branches | The target branches for the merged PR, ingnores PRs with different target branch. Values can be a `regex`. Default: allow all base branches | | trim_values | Defines if all values inserted in templates are `trimmed`. Default: false |