Merge GitHub pull request

github.mergePullRequest merges a pull request through GitHub.

automations/merge-github-pull-request.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("Merge GitHub pull request", () => {
  onDashboardRun({ title: "Merge GitHub pull request" })
  github.mergePullRequest({
    owner: "SentsCo",
    repository: "automate.ax",
    pullRequestNumber: 173,
    mergeMethod: "squash",
  })
})

Provide owner, repository, and positive integer pullRequestNumber. Optional fields are commitTitle, commitMessage, and expected head sha. Optional second argument { account } selects the GitHub binding. mergeMethod accepts "merge", "rebase", or "squash". Inputs accept compatible signals. Returns { merged: boolean; message: string; sha: string | null }. When merged is false, message explains why. Repository rules, required checks, reviews, conflicts, methods that the repository doesn’t allow, or a mismatched sha can prevent merging.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Merge GitHub pull request