Update GitHub issue

github.updateIssue updates fields shared by GitHub issues and pull requests.

automations/close-github-issue.automation.ts

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

export default automation("Close GitHub issue", () => {
  onDashboardRun({ title: "Close GitHub issue" })
  github.updateIssue({
    owner: "SentsCo",
    repository: "automate.ax",
    issueNumber: 179,
    state: "closed",
    stateReason: "completed",
  })
})

Provide owner, repository, and positive integer issueNumber. Optional replacements are title, body, assignees, labels, milestone, issueFieldValues, type, state, stateReason, and duplicateIssueId. title and milestone accept a string, integer, or null; body and type are also nullable. An empty assignees or labels array clears that collection. stateReason accepts "completed", "duplicate", "not_planned", "reopened", or null. duplicateIssueId is the canonical issue database ID and is used only with the "duplicate" reason. Assignees accept login strings or objects with login; labels accept names or objects with id, name, description, and color. Custom issue field values contain integer fieldId and a string, number, or string-array value. Structured assignees, labels, custom fields, and issue types may also include rationale, suggest, and confidence ("low", "medium", or "high"). A structured issue type uses value for its name or null to remove the current type. Optional second argument { account } defaults to the project binding. Inputs accept compatible signals. Returns the updated issue or pull request’s id, number, title, and any pending suggestions GitHub reports for requested fields. The installation needs either Issues write or Pull requests write permission. Setting assignees, labels, a milestone, custom fields, or an issue type also requires push access; GitHub silently drops applicable changes without it.

Built-in triggers

Built-in actions

Runtime utilities

Integrations