wiyco/Vercel Deploy Comment
Deploy one or more Vercel projects and environments and keep a Vercel-style pull request comment updated.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token used to list, create, and update pull request comments. Defaults to the workflow GITHUB_TOKEN. | no | ${{ github.token }} |
| vercel-token | Vercel token used for isolated pull/build/deploy execution and Vercel API enrichment. | no | — |
| mode | Either deploy-and-comment or comment-only. | no | deploy-and-comment |
| deployment-concurrency | Maximum number of deploy-and-comment entries to execute at once. | no | 2 |
| deployments | JSON array describing one or more project-driven deployments. deploy-and-comment entries require cwd, projectId, orgId, environment, and an absolute https projectUrl, and may include an absolute https deploymentUrl. comment-only entries require projectId, environment, an absolute https projectUrl, and an absolute https deploymentUrl, and may include status: ready|failed|cancelled|skipped|in_progress. | yes | — |
| header | Markdown heading text for the pull request comment. | no | Vercel Preview Deployment |
| footer | Optional Markdown footer appended below the deployment table. | no | — |
| comment-marker | Stable marker key used to find and update the existing action comment. | no | default |
| status | Fallback GitHub Actions status when Vercel deployment details are unavailable. In comment-only mode, an explicit deployments[].status overrides this value per deployment. | no | success |
| comment-on-failure | Whether deploy failures should still update the pull request comment before failing the action. | no | true |
| job-status | Internal GitHub Actions job status used by the post-execution cleanup. | no | ${{ job.status }} |
Outputs
| name | description |
|---|---|
| comment-id | ID of the created or updated pull request comment. |
| comment-url | URL of the created or updated pull request comment. |
| deployment-urls | JSON array of preview deployment URLs produced for the current deployments input, in input order with rows that have URLs. |
| statuses | JSON array of normalized status keys produced for the current deployments input, in input order. |