ek9_git_merge
Reports status and outcome (already-up-to-date, fast-forward, clean-merge or conflict), newSha/previousSha, commitsMerged, changedFiles and conflictFiles; a conflicting merge aborts with the tree restored.
When to use it
'Merge feature-x into this branch' - one call with branch; dryRun:true predicts the outcome and the conflicting files without merging. Use mode:'merge-commit' to keep the branch visible in the graph, mode:'ff-only' to refuse a real merge.
When not to use it
- integrating the REMOTE upstream - use
ek9_git_pullmode:'merge'. - just moving to the branch - use
ek9_git_switch. - undoing a commit - use
ek9_git_revert.
Details
outcome shares one vocabulary between preview and apply: already-up-to-date / fast-forward / clean-merge / conflict (conflict only in a preview - the real merge aborts it). Apply status: merged / fast-forward / already-up-to-date with dryRun:false; preview status: ready / conflicts / unchanged with dryRun:true (an in-memory merge-tree, git 2.38+). A dirty tree is refused (dirty-tree); a conflicting merge is aborted with treeRestored:true. noFastForward:true is the IDE alias of mode:'merge-commit'.
Arguments
| Argument | Type | Required | What it is |
|---|---|---|---|
branch | string | yes | The local branch to merge into the current branch. |
dryRun | boolean | Predict the outcome, the changed and the conflicting files without merging. Default false. | |
message | string | Merge-commit message. Default: git's own. | |
mode | string: auto | merge-commit | ff-only | Default auto (fast-forward when possible, else a merge commit); merge-commit always records one (--no-ff); ff-only refuses when a merge commit would be needed. | |
noFastForward | boolean | IDE alias of mode:'merge-commit'. |