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

- update documentation with flags config for label_extractor

Browse Source
This commit is contained in:
Mike Penz
2021-06-23 16:16:20 +02:00
parent f2fcbb1f9b
commit d517474db1
2 changed files with 84 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -1
View File
@@ -168,7 +168,8 @@ This configuration is a `.json` file in the following format.
"label_extractor": [
{
"pattern": "(.) (.+)",
"target": "$1"
"target": "$1",
"flags": "gu"
},
{
"pattern": "(.) (.+)",
@@ -295,6 +296,7 @@ Table of descriptions for the `configuration.json` options to configure the resu
| label_extractor.pattern | A `regex` pattern, extracting values of the change message. |
| label_extractor.target | The result pattern. The result text will be used as label. If empty, no label is created. |
| label_extractor.on_property | The property to retrieve the text from. This is optional. Defaults to: `body`. Alternative values: `title`, `author`, `milestone`. |
| label_extractor.flags | Defines the regex flags specified for the pattern. Default: `gu` |
| transformers | An array of `transform` specifications, offering a flexible API to modify the text per pull request. This is applied on the change text created with `pr_template`. `transformers` are executed per change, in the order specified |
| transformer.pattern | A `regex` pattern, extracting values of the change message. |
| transformer.target | The result pattern, the regex groups will be filled into. Allows for full transformation of a pull request message. Including potentially specified texts |