Merge Pull Request

Merges a pull request

Usage #

// Import the typed helper
import { mergePullRequest } from "@hotglue/sdk/github";
const result = await client.execute({
...mergePullRequest({
owner: string,
repo: string,
pull_number: string,
// ...
}),
userId: "user_123",
});
// result is typed as MergePullRequestOutput
const result = await client.execute({
integration: "github",
tool: "merge_pull_request",
userId: "user_123",
input: {
owner: string,
repo: string,
pull_number: string,
// ...
},
});
// The agent will automatically use this tool when needed
const agent = new Agent({
tools: () => hotglueTools({
integrations: ["github"],
userId: "user_123",
}),
});
await agent.generate("run the Merge Pull Request tool");

Required Permissions #

repo

Input Schema #

owner string required

Repository owner

repo string required

Repository name

pull_number string required

Pull request number

commit_title string

Title for merge commit

commit_message string

Extra detail for merge commit

sha string

SHA that head must match to merge

merge_method string

Merge method to use

default: merge values: merge, squash, rebase

Output Schema #

sha string required
merged bool required
message string required

This tool calls: #

PUT https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/merge