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

> Run when a GitHub deployment status succeeds.

`github.onDeploymentSucceeded` emits deployment statuses with `state: "success"`.

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

export default automation("GitHub deployment succeeded", () => {
  const event = github.onDeploymentSucceeded()
  // Update the GitHub deployment in the release dashboard.
})
```

Returns the typed deployment-status payload, including environment and environment URL. Requires Deployments read permission.