Vercel

Deploys a release artifact to Vercel as a production deployment.

The target extracts a ZIP artifact and deploys it via the Vercel deploy API (using @vercel/client) to promote it to production. It does not use or require the vercel CLI.

Configuration

Option	Description
prebuilt	Whether the artifact contains a prebuilt .vercel/output (the result of vercel build). When true (default), the artifact’s prebuilt .vercel/output is uploaded and the remote build step is skipped. Set to false to have Vercel build from source.
workingDir	Subdirectory within the extracted artifact to deploy from.
orgId	Vercel organization/team ID. Use this for a repository-specific team; VERCEL_ORG_ID overrides it when set.
projectId	Vercel project ID. Use this for a repository-specific project; VERCEL_PROJECT_ID overrides it when set.

Environment Variables

Name	Required	Description
VERCEL_TOKEN	Yes	Vercel access token. Passed to the deploy API, never on the command line.
VERCEL_ORG_ID	No	Vercel organization/team ID. An identifier, not a secret. Forwarded to the deploy API as the team ID so the deployment links non-interactively.
VERCEL_PROJECT_ID	No	Vercel project ID. An identifier, not a secret. Forwarded to the deploy API as the project identifier so the deployment links to the intended project non-interactively.

Note

For non-interactive CI deployments, set both VERCEL_ORG_ID and VERCEL_PROJECT_ID so the deploy API knows which project to deploy to.

Default Behavior

By default, this target:

1. Looks for a single artifact matching vercel.zip (or *-vercel.zip). Override with includeNames.
2. Extracts its contents (preserving the archive layout, e.g. a top-level .vercel/output).
3. Deploys to production via the Vercel deploy API.

The version being released is attached to the deployment as metadata (release=<version>) for traceability.

Example

targets:
  - name: vercel
    orgId: team_example
    projectId: prj_example
    # prebuilt defaults to true: the docs site is built in CI and this
    # target only promotes the prebuilt output to production.

Deploying from a subdirectory of the artifact:

targets:
  - name: vercel
    workingDir: docs

Workflow

1. Build the site in CI (e.g. vercel build) and create a vercel.zip artifact containing the prebuilt .vercel/output (or the source when prebuilt: false).
2. Configure the target in .craft.yml.
3. Set VERCEL_TOKEN in your environment. Set orgId and projectId in .craft.yml, or set VERCEL_ORG_ID and VERCEL_PROJECT_ID when the shared publish environment must override the repository config.