Get GitHub pull request

github.getPullRequest gets a pull request with its branches, merge state, requested reviewers, labels, and repository metadata.

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

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

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

Provide owner, repository, and positive integer pullRequestNumber. Optional second argument { account } defaults to the project binding. Inputs accept compatible signals. Returns the pull request’s id, number, title, and head ref and sha. GitHub returns an error if the installation can’t access the repository or the pull request doesn’t exist.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Get GitHub pull request