Create GitHub check run

github.createCheckRun creates a check run for one commit SHA.

automations/create-github-check-run.automation.ts

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

export default automation("Create GitHub check", () => {
  github.createCheckRun({
    headSha: "commit-sha",
    name: "Automate.ax policy",
    owner: "SentsCo",
    repository: "automate.ax",
    status: "in_progress",
  })
})

Provide the repository, headSha, and a name of at most 100 characters. status defaults to "queued"; setting it to "completed" requires a conclusion. Optional fields include detailsUrl, externalId, startedAt, up to three actions, and rich output with up to 50 annotations. Annotation columns must be supplied together and only for a single-line range. Returns the check run’s id, name, head_sha, status, and conclusion. Requires Checks write permission.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Create GitHub check run