Create GitHub deployment

github.createDeployment creates a deployment record for a ref.

automations/create-github-deployment.automation.ts

import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("Create GitHub deployment", () => {
  github.createDeployment({
    autoMerge: false,
    environment: "production",
    owner: "SentsCo",
    payload: { releaseId: "rel_123" },
    productionEnvironment: true,
    ref: "v2.0.0",
    repository: "automate.ax",
  })
})

Provide the repository and branch, tag, or commit ref. task defaults to "deploy"; autoMerge defaults to true. Omit requiredContexts to require every unique commit-status context before deployment. Pass an empty array to bypass status checks, or list the exact contexts GitHub must verify. Optional fields also include JSON payload, environment, description, transientEnvironment, and productionEnvironment. Returns the deployment’s id, ref, and environment, or GitHub’s accepted auto-merge message when it must update the ref first. Requires Deployments write permission.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Create GitHub deployment