> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Create GitHub check run

> Create a check run for one GitHub commit.

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

```ts automations/create-github-check-run.automation.ts theme={null}
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.