Skip to content

Support signing in Repository#mergeBranches #1664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
implausible merged 3 commits into from
Apr 17, 2019
Merged

Support signing in Repository#mergeBranches #1664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7548684
Support signing in Repository#mergeBranches
ianhattendorf Apr 17, 2019
4259208
Add deprecation warning for Repository#mergeBranches parameter
ianhattendorf Apr 17, 2019
17aca8c
Don't use newly deprecated parameter in tests
ianhattendorf Apr 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions lib/repository.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1686,6 +1686,7 @@ Repository.prototype.refreshIndex = function(callback) {
* @param {Signature} signature
* @param {Merge.PREFERENCE} mergePreference
* @param {MergeOptions} mergeOptions
* @param {MergeBranchOptions} mergeBranchOptions
* @return {Oid|Index} A commit id for a succesful merge or an index for a
* merge with conflicts
*/
Expand All @@ -1695,13 +1696,23 @@ Repository.prototype.mergeBranches = function(
signature,
mergePreference,
mergeOptions,
processMergeMessageCallback
mergeBranchOptions
) {
const repo = this;
let fromBranch;
let toBranch;
processMergeMessageCallback = processMergeMessageCallback ||
// Support old parameter `processMergeMessageCallback`
const isOldOptionParameter = typeof mergeBranchOptions === "function";
Copy link
Member

@implausible implausible Apr 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you output a console.error warning that this parameter is deprecated and should be updated to the new object type?

Copy link
Member

@implausible implausible Apr 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any tests that use this method should also be updated to use the new parameter format.

if (isOldOptionParameter) {
console.error("DeprecationWarning: Repository#mergeBranches parameter " +
"processMergeMessageCallback, use MergeBranchOptions");
}
const processMergeMessageCallback = mergeBranchOptions &&
(isOldOptionParameter ?
mergeBranchOptions :
mergeBranchOptions.processMergeMessageCallback) ||
function (message) { return message; };
const signingCallback = mergeBranchOptions && mergeBranchOptions.signingCb;

mergePreference = mergePreference || NodeGit.Merge.PREFERENCE.NONE;
mergeOptions = normalizeOptions(mergeOptions, NodeGit.MergeOptions);
Expand Down Expand Up @@ -1819,6 +1830,17 @@ Repository.prototype.mergeBranches = function(
return Promise.all([oid, processMergeMessageCallback(message)]);
})
.then(([oid, message]) => {
if (signingCallback) {
return repo.createCommitWithSignature(
toBranch.name(),
signature,
signature,
message,
oid,
[toCommitOid, fromCommitOid],
signingCallback
);
}
return repo.createCommit(
toBranch.name(),
signature,
Expand Down
16 changes: 10 additions & 6 deletions test/tests/merge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -646,9 +646,11 @@ describe("Merge", function() {
ourSignature,
NodeGit.Merge.PREFERENCE.NO_FASTFORWARD,
null,
function(message) {
assert(message === "Merge branch 'theirs' into ours");
return "We manipulated the message, HAH.";
{
processMergeMessageCallback: function(message) {
assert(message === "Merge branch 'theirs' into ours");
return "We manipulated the message, HAH.";
}
}
);
})
Expand Down Expand Up @@ -803,9 +805,11 @@ describe("Merge", function() {
ourSignature,
NodeGit.Merge.PREFERENCE.NO_FASTFORWARD,
null,
function(message) {
assert(message === "Merge branch 'theirs' into ours");
return Promise.resolve("We manipulated the message, HAH.");
{
processMergeMessageCallback: function(message) {
assert(message === "Merge branch 'theirs' into ours");
return Promise.resolve("We manipulated the message, HAH.");
}
}
);
})
Expand Down