Get GitHub issue

getGitHubIssue gets an issue or pull request through GitHub’s shared Issues API.

automations/get-github-issue.automation.ts

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

export default automation("Get GitHub issue", () => {
  onHttpRequest({ scope: "automation" })
  getGitHubIssue({
    owner: "SentsCo",
    repository: "automate.ax",
    issueNumber: 179,
  })
})

owner, repository, and positive integer issueNumber are required. Optional account defaults to the project’s GitHub binding. Inputs accept compatible signals. Returns GitHub’s complete typed issue object, including identifiers, state, title, body, labels, assignees, milestone, comments, timestamps, and URLs. Pull requests include a pull_request marker. GitHub returns an error when the installation cannot access the repository or the number does not exist.

⌘I

Get started

Concepts

Reference