vercel-action/action.yml at f58f5c52817bba5c74955e58ac8b35796dcd1062 · amondnet/vercel-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
name: Vercel Action
description: This action make a deployment with github actions instead of Vercel builder.
inputs:
  vercel-token:
    description: Vercel token
    required: true
  vercel-args:
    description: ''
    required: false
    default: ''
  github-comment:
    required: false
    default: 'true'
    description: 'if you want to comment on pr and commit, set true, default: true'
  github-token:
    required: false
    description: 'if you want to comment on pr and commit, set token'
  github-deployment:
    required: false
    default: 'false'
    description: 'if you want to create github deployment, set true, default: false'
  github-deployment-environment:
    required: false
    description: 'The environment for the GitHub deployment (e.g., production, staging, preview). If not specified, auto-detects: "production" when vercel-args contains --prod or --production, otherwise "preview".'
    default: ''
  working-directory:
    required: false
    description: the working directory
  vercel-project-id:
    required: false
    description: 'Vercel CLI 17+, ❗️  The `name` property in vercel.json is deprecated (https://zeit.ink/5F)'
  vercel-org-id:
    required: false
    description: 'Vercel team ID (also used as teamId for API deployments). Vercel CLI 17+, ❗️  The `name` property in vercel.json is deprecated (https://zeit.ink/5F)'
  vercel-project-name:
    required: false
    description: "The name of the project; if absent we'll use the `vercel inspect` command to determine."
  vercel-version:
    required: false
    description: vercel-cli package version
  scope:
    required: false
    description: 'Team slug for Vercel CLI --scope flag. For API deployments, use vercel-org-id instead.'
    deprecationMessage: 'Use "vercel-org-id" for team identification. The "scope" input is only used for CLI-based deployments (when vercel-args is provided).'
  zeit-token:
    description: zeit.co token
    required: false
    deprecationMessage: 'Zeit is now Vercel. Use "vercel-token" instead'
  now-args:
    description: ''
    required: false
    default: ''
    deprecationMessage: 'Zeit is now Vercel. Use "vercel-args" instead.'
  now-project-id:
    required: false
    description: 'Vercel CLI 17+, ❗️  The `name` property in vercel.json is deprecated (https://zeit.ink/5F)'
    deprecationMessage: 'Zeit is now Vercel. Use "vercel-project-id" instead.'
  now-org-id:
    required: false
    description: 'Vercel CLI 17+, ❗️  The `name` property in vercel.json is deprecated (https://zeit.ink/5F)'
    deprecationMessage: 'Zeit is now Vercel. Use "vercel-org-id" instead.'
  alias-domains:
    required: false
    description: 'You can assign a domain to this deployment. Please note that this domain must have been configured in the project. You can use pull request number via `{{PR_NUMBER}}` and branch via `{{BRANCH}}`'
    default: ''
  target:
    required: false
    description: 'Deployment target: "production" or "preview" (default: preview). Replaces --prod flag in vercel-args.'
    default: preview
  prebuilt:
    required: false
    description: 'Deploy prebuilt output (default: false). Replaces --prebuilt flag in vercel-args.'
    default: 'false'
  vercel-output-dir:
    required: false
    description: 'Path to the prebuilt output directory. Defaults to {working-directory}/.vercel/output when prebuilt is true.'
    default: ''
  force:
    required: false
    description: 'Force new deployment, bypassing dedupe and build cache (default: false). Replaces --force flag in vercel-args.'
    default: 'false'
  env:
    required: false
    description: Environment variables for the deployment (KEY=VALUE per line). Replaces --env flags in vercel-args.
    default: ''
  build-env:
    required: false
    description: Build-time environment variables (KEY=VALUE per line). Replaces --build-env flags in vercel-args.
    default: ''
  regions:
    required: false
    description: 'Deployment regions, comma-separated (e.g. "iad1,sfo1").'
    default: ''
  archive:
    required: false
    description: 'Upload format: "tgz" for compressed archive, or empty for individual files.'
    default: ''
  root-directory:
    required: false
    description: Root directory of the project relative to the repository root.
    default: ''
  auto-assign-custom-domains:
    required: false
    description: 'Automatically assign custom domains to this deployment (default: true).'
    default: 'true'
  custom-environment:
    required: false
    description: Custom environment slug or ID for the deployment.
    default: ''
  public:
    required: false
    description: 'Make deployment source publicly accessible (default: false).'
    default: 'false'
  with-cache:
    required: false
    description: 'Retain build cache from previous deployments (default: false).'
    default: 'false'
  source-files-outside-root-directory:
    required: false
    description: 'Indicates if there are source files outside of the root directory, typically used for monorepos (default: false).'
    default: 'false'
  node-version:
    required: false
    description: 'Node.js version for the deployment. Must be one of "24.x", "22.x", "20.x". When unset, falls back to package.json engines.node.'
    default: ''

outputs:
  preview-url:
    description: deployment preview URL
  preview-name:
    description: deployment preview name
  deployment-id:
    description: GitHub Deployment ID (only set when github-deployment is true)
runs:
  using: node24
  main: dist/index.js

branding:
  icon: triangle
  color: white