mikepenz/release-changelog-builder-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1350 from KonradHoeffner/patch-1

Browse Source 
clarify tag_resolver.filter documentation
This commit is contained in:
Mike Penz
2024-08-02 09:16:45 +02:00
committed by GitHub
parent ef820d296c c07488ea78
commit 92bd1e6e03
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -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 |