Skip to content

Commit 078680a

Browse files
committed
Update Release:finish documentation with options object
1 parent ac5e041 commit 078680a

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docs/Release.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ Finishes a git flow "release"
3838
| releaseVersion | <code>String</code> | The name of the release to finish |
3939
| options | <code>Object</code> | Options for finish release |
4040

41+
**Options**:
42+
43+
| Option | Type | Description |
44+
| --- | --- | --- |
45+
| keepBranch | Boolean | Keep the branch after merge |
46+
| message | String | Tag will be created with this message |
47+
| processMergeMessageCallback | Function | Callback that is fired before merge occurs. If the callback returns a Promise, the **processMergeMessageCallback** promise must succeed before the merge occurs. The result of the **processMergeMessageCallback** must be a string or a promise that resolves to a string, as that message will be used for the merge message. the **processMergeMessageCallback** will be called with the generated merge message as a parameter. |
48+
| postDevelopMergeCallback | Function | Callback fired after a successful merge with development occurs. |
49+
| postMasterMergeCallback | Function | Callback fired after a successful merge with master occurs. |
50+
4151
<a name="Release.startRelease"></a>
4252
### Release.startRelease(repo, releaseVersion, options) ⇒ <code>Branch</code>
4353
Starts a git flow "release"
@@ -66,3 +76,12 @@ Finishes a git flow "release"
6676
| releaseVersion | <code>String</code> | The name of the release to finish |
6777
| options | <code>Object</code> | Options for finish release |
6878

79+
**Options**:
80+
81+
| Option | Type | Description |
82+
| --- | --- | --- |
83+
| keepBranch | Boolean | Keep the branch after merge |
84+
| message | String | Tag will be created with this message |
85+
| processMergeMessageCallback | Function | Callback that is fired before merge occurs. If the callback returns a Promise, the **processMergeMessageCallback** promise must succeed before the merge occurs. The result of the **processMergeMessageCallback** must be a string or a promise that resolves to a string, as that message will be used for the merge message. the **processMergeMessageCallback** will be called with the generated merge message as a parameter. |
86+
| postDevelopMergeCallback | Function | Callback fired after a successful merge with development occurs. |
87+
| postMasterMergeCallback | Function | Callback fired after a successful merge with master occurs. |

0 commit comments

Comments
 (0)