Create deployment

createVercelDeployment starts a build from Git or an existing deployment.

automations/create-vercel-deployment.automation.ts

import { automation } from "automate.ax"
import { createVercelDeployment } from "automate.ax/vercel"

export default automation("Deploy Vercel project", () => {
  const deployment = createVercelDeployment({
    gitSource: { ref: "main", repoId: 123456, type: "github" },
    name: "docs-site",
    project: "prj_123",
    target: "production",
  })
  deployment.id
})

name and either gitSource or deploymentId are required. Git sources support GitHub repository IDs, GitLab project IDs, and Bitbucket repository UUIDs, with a ref and optional SHA. deploymentId redeploys an existing build; withLatestCommit defaults to false. Optional project, target, customEnvironment, metadata, forceNew, and skipAutoDetectionConfirmation expose common provider controls. The output is Vercel’s complete typed created-deployment response.

⌘I

Get started

Concepts

Reference