Skip to main content
Merge a branch.
External DocumentationTo learn more, visit the GitHub documentation.

​
Parameters

ParameterDescription
Commit MessageCommit message to use for the merge commit. If omitted, a default message will be used.
OwnerThe organization or person who owns the repository. github.com//
RepoName of the repository owned by the owner. github.com//
Source BranchThe head to merge. This can be a branch name or a commit SHA1.
Target BranchThe name of the base branch that the head will be merged into.

​
Example Output

{
	"sha": "<string>",
	"node_id": "<string>",
	"commit": {
		"author": {
			"name": "<string>",
			"email": "<string>",
			"date": "2025-03-12T13:58:09Z"
		},
		"committer": {
			"name": "<string>",
			"email": "<string>",
			"date": "2025-03-12T13:58:09Z"
		},
		"message": "<string>",
		"tree": {
			"sha": "<string>",
			"url": "<string>"
		},
		"url": "<string>",
		"comment_count": 0,
		"verification": {
			"verified": true,
			"reason": "<string>",
			"signature": "<string>",
			"payload": "<string>",
			"verified_at": "2021-10-28T16:05:50Z"
		}
	},
	"url": "<string>",
	"html_url": "<string>",
	"comments_url": "<string>",
	"author": {
		"login": "<string>",
		"id": 143816349,
		"node_id": "<string>",
		"avatar_url": "<string>",
		"gravatar_id": "<string>",
		"url": "<string>",
		"html_url": "<string>",
		"followers_url": "<string>",
		"following_url": "<string>",
		"gists_url": "<string>",
		"starred_url": "<string>",
		"subscriptions_url": "<string>",
		"organizations_url": "<string>",
		"repos_url": "<string>",
		"events_url": "<string>",
		"received_events_url": "<string>",
		"type": "<string>",
		"user_view_type": "<string>",
		"site_admin": false
	},
	"committer": {
		"login": "<string>",
		"id": 8957500,
		"node_id": "<string>",
		"avatar_url": "<string>",
		"gravatar_id": "<string>",
		"url": "<string>",
		"html_url": "<string>",
		"followers_url": "<string>",
		"following_url": "<string>",
		"gists_url": "<string>",
		"starred_url": "<string>",
		"subscriptions_url": "<string>",
		"organizations_url": "<string>",
		"repos_url": "<string>",
		"events_url": "<string>",
		"received_events_url": "<string>",
		"type": "<string>",
		"user_view_type": "<string>",
		"site_admin": false
	},
	"parents": [
		{
			"sha": "<string>",
			"url": "<string>",
			"html_url": "<string>"
		},
		{
			"sha": "<string>",
			"url": "<string>",
			"html_url": "<string>"
		}
	]
}

​
Workflow Library Example

Merge with Github and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop