Skip to content

Commit 744aa05

Browse files
committed
Update Feature:finish documentation with options object
1 parent 43a9ca8 commit 744aa05

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/Feature.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Starts a git flow "feature"
2525
| featureName | <code>String</code> | The name of the feature to start |
2626
| options | <code>Object</code> | Options for start feature |
2727

28+
2829
<a name="Feature+finishFeature"></a>
2930
### feature.finishFeature(featureName, options) ⇒ <code>Commit</code>
3031
Finishes a git flow "feature"
@@ -38,6 +39,17 @@ Finishes a git flow "feature"
3839
| featureName | <code>String</code> | The name of the feature to finish |
3940
| options | <code>Object</code> | Options for finish feature |
4041

42+
**Options**:
43+
44+
| Option | Type | Description |
45+
| --- | --- | --- |
46+
| keepBranch | Boolean | Keep the branch after merge |
47+
| isRebase | Boolean | Use Rebase instead of merge |
48+
| preRebaseCallback | Function | Callback that is fired before rebase occurs, only applicable if **isRebase** is truthy. If the callback returns a Promise, the **preRebaseCallback** promise must succeed before the rebase occurs. The **preRebaseCallback** is called with development branch name and the feature branch name. |
49+
| processMergeMessageCallback | Function | Callback that is fired before merge occurs, only applicable if **isRebase** is falsy. 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. |
50+
| postMergeCallback | Function | Callback fired after a successful merge occurs. |
51+
| beforeRebaseFinishCallback | Function | Callback that is fired right before a rebase is finished with metadata reflecting the rebase operation in full. See [Rebase Branches](http://www.nodegit.org/api/repository/#rebaseBranches) |
52+
4153
<a name="Feature.startFeature"></a>
4254
### Feature.startFeature(repo, featureName, options) ⇒ <code>Branch</code>
4355
Starts a git flow "feature"
@@ -66,3 +78,13 @@ Finishes a git flow "feature"
6678
| featureName | <code>String</code> | The name of the feature to finish |
6779
| options | <code>Object</code> | Options for finish feature |
6880

81+
**Options**:
82+
83+
| Option | Type | Description |
84+
| --- | --- | --- |
85+
| keepBranch | Boolean | Keep the branch after merge |
86+
| isRebase | Boolean | Use Rebase instead of merge |
87+
| preRebaseCallback | Function | Callback that is fired before rebase occurs, only applicable if **isRebase** is truthy. If the callback returns a Promise, the **preRebaseCallback** promise must succeed before the rebase occurs. The **preRebaseCallback** is called with development branch name and the feature branch name. |
88+
| processMergeMessageCallback | Function | Callback that is fired before merge occurs, only applicable if **isRebase** is falsy. 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. |
89+
| postMergeCallback | Function | Callback fired after a successful merge occurs. |
90+
| beforeRebaseFinishCallback | Function | Callback that is fired right before a rebase is finished with metadata reflecting the rebase operation in full. See [Rebase Branches](http://www.nodegit.org/api/repository/#rebaseBranches) |

0 commit comments

Comments
 (0)