> ## 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 deployment status

> Report a lifecycle status for a GitHub deployment.

`github.createDeploymentStatus` records a new state for a deployment.

```ts automations/report-github-deployment.automation.ts theme={null}
import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("Report GitHub deployment", () => {
  github.createDeploymentStatus({
    deploymentId: 123456,
    description: "Production is healthy",
    environment: "production",
    environmentUrl: "https://automate.ax",
    owner: "SentsCo",
    repository: "automate.ax",
    state: "success",
  })
})
```

Provide the repository, `deploymentId`, and `state`: `"error"`, `"failure"`, `"inactive"`, `"in_progress"`, `"pending"`, `"queued"`, or `"success"`. Optional fields are `description`, `environment`, `environmentUrl`, `logUrl`, and legacy `targetUrl`. `autoInactive` defaults to `true`. Returns the status's `id` and `state`. GitHub does not emit `deployment_status` webhooks for `inactive` states. Requires Deployments write permission.