> ## 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.

# On GitHub check run succeeded

> Start an automation when a GitHub check run succeeds.

`github.onCheckRunSucceeded` starts an automation for a completed check run with conclusion `"success"`.

```ts automations/github-check-run-succeeded.automation.ts theme={null}
import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("GitHub check passed", () => {
  const event = github.onCheckRunSucceeded()
  github.createCommitStatus({
    owner: event.repository.owner.login,
    repository: event.repository.name,
    sha: event.check_run.head_sha,
    state: "success",
  })
})
```

Returns the typed payload with `check_run.conclusion: "success"`. Requires Checks read permission.