Skip to content

Commit e361556

Browse files
Add demo config to PHPDoc
1 parent e244b09 commit e361556

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/Hook/Message/Action/InjectIssueKeyFromBranch.php

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,20 @@
2828
* Class PrepareFromFile
2929
*
3030
* Example configuration:
31+
*
32+
* <code>
3133
* {
32-
* "action": "\\CaptainHook\\App\\Hook\\Message\\Action\\InjectIssueKeyFromBranch",
34+
* "action": "CaptainHook.Message.InjectIssueKeyFromBranch",
3335
* "options": {
3436
* "regex": "#([A-Z]+\\-[0-9]+)#i",
35-
* "into": "body",
36-
* "mode": "append",
37-
* "prefix": "\nissue: ",
37+
* "into": "body|subject",
38+
* "mode": "append|prepend",
39+
* "prefix": "",
40+
* "suffix": "",
3841
* "force": true
3942
* }
4043
* }
44+
* </code>
4145
*
4246
* The regex option needs group $1 (...) to be the issue key
4347
*

0 commit comments

Comments
 (0)