Create GitHub deployment status

github.createDeploymentStatus records a new state for a deployment.

automations/report-github-deployment.automation.ts

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.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Create GitHub deployment status