MergePullRequest

Automates the merging of an open pull request into the target branch, integrating proposed changes into the main codebase.


Name	Type	Description
PullRequestId	String	Specifies the unique identifier (ID) for the pull request that is being merged. This is a required parameter to identify the specific pull request to operate on.
CommitHeadline	String	Specifies the title for the merge commit message. If this is not provided, a default commit message is generated automatically to describe the merge action.
CommitBody	String	Specifies the detailed description for the merge commit message. If this is not supplied, a default description is created to summarize the merge process.
ExpectedHeadOid	String	Represents the expected commit object ID (OID) of the pull request's head branch. The merge operation proceeds only if the OID matches the current state. If this is left empty, no validation is performed, and the merge proceeds regardless of the branch state.
MergeMethod	String	Defines the merging strategy to use when combining the pull request's changes into the target branch. Options include 'MERGE', 'SQUASH', or 'REBASE'. If this is not specified, the default method used is 'MERGE'. The allowed values are MERGE, SQUASH, REBASE.
AuthorEmail	String	Specifies the email address to associate with the merge commit's author. This field helps track who is responsible for the merge in the commit history.


Name	Type	Description
Success	Boolean	Indicates whether the merge was successful. A 'true' value signifies the merge was completed without issues, while a 'false' value means an error occurred during the merge process.
Details	String	Provides additional details or error messages related to the merge operation. This can include any warnings or specific issues encountered during the merge attempt.
PullRequestId	String	Represents the unique identifier of the pull request that was successfully merged. This ensures you can track which pull request was processed in the merge operation.

Excel Add-In for GitHub