Get GitHub pull request

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

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

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

export default automation("Get GitHub pull request", () => {
  onHttpRequest({ scope: "automation" })
  getGitHubPullRequest({
    owner: "SentsCo",
    repository: "automate.ax",
    pullRequestNumber: 173,
  })
})

owner, repository, and positive integer pullRequestNumber are required. Optional account defaults to the project binding. Inputs accept compatible signals. Returns GitHub’s complete typed pull request object. GitHub returns an error when the installation cannot access the repository or the pull request does not exist.

⌘I

Get started

Concepts

Reference

Get GitHub pull request