mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 18:11:51 +08:00
## Summary
- `vercel/wait-for-deployment-action` in
[docs-e2e.yml](.github/workflows/docs-e2e.yml) polls GitHub's
Deployments API for a `Preview – docs` deployment, but Vercel's GitHub
App has not written a GitHub Deployment object repo-wide since
2026-02-17 (broken app auth). The step times out after 900s on every PR
that touches `apps/docs`, even though the preview build itself succeeds
(`Vercel – docs` commit status is green).
- Replace the wait step with a custom poll of the `Vercel – docs` commit
status (which Vercel keeps posting correctly), then resolve the actual
preview URL via Vercel's own deployments API (`GET
/v13/deployments/{id}`) using the deployment ID embedded in the commit
status's `target_url`, reusing the existing `VERCEL_TOKEN` /
`VERCEL_TEAM_ID` secrets.
- Drops the now-unused `deployments: read` permission.
## Context
Reported in Slack:
https://supabase.slack.com/archives/C023E4L60R3/p1784721725606599?thread_ts=1784658589.182079&cid=C023E4L60R3
(surfaced by [#48178](https://github.com/supabase/supabase/pull/48178)
failing on this step — [run
29916797889](https://github.com/supabase/supabase/actions/runs/29916797889?pr=48178)).
Agreed workaround from that thread: swap the wait step to poll the
`Vercel – docs` commit status instead of the Deployments API.
## Test plan
- [ ] Confirm this workflow run (triggered by this PR since it edits
`apps/docs/**`... actually this PR only touches the workflow file, so
verify via `workflow_dispatch` or a follow-up PR touching
`apps/docs/**`) passes the "Wait for Vercel docs preview" step and
resolves a working `deployment-url`
- [ ] Confirm downstream Playwright E2E run against the resolved preview
URL succeeds
- [ ] Confirm the step still fails cleanly (clear error, no silent hang)
if the Vercel deployment itself fails
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Bug Fixes**
* Improved documentation preview deployment handling in end-to-end
tests.
* Replaced the preview wait logic with more reliable polling for the
relevant commit status, including clear success/failure/error and
timeout behavior.
* Resolve the correct documentation preview URL before tests proceed.
* **Chores**
* Tightened permissions for the documentation E2E workflow to use only
the required access scopes.
* Streamlined job setup steps so Node/Pnpm preparation runs earlier in
the workflow.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude Sonnet 5 <[email protected]>
109 lines
3.7 KiB
JavaScript
109 lines
3.7 KiB
JavaScript
// Vercel's GitHub App has stopped writing GitHub Deployment objects since
|
||
// 2026-02-17 (broken app auth), so polling the Deployments API (as
|
||
// vercel/wait-for-deployment-action does) times out even though the docs
|
||
// preview builds fine. Poll the "Vercel – docs" commit status instead, then
|
||
// resolve the actual preview URL via Vercel's own deployments API.
|
||
const { appendFileSync } = require('fs')
|
||
|
||
const STATUS_CONTEXT = 'Vercel – docs'
|
||
const TIMEOUT_MS = 900_000
|
||
const POLL_INTERVAL_MS = 15_000
|
||
|
||
async function fetchLatestStatus(repository, sha, githubToken) {
|
||
const url = `https://api.github.com/repos/${repository}/commits/${sha}/statuses`
|
||
const response = await fetch(url, {
|
||
headers: {
|
||
Authorization: `Bearer ${githubToken}`,
|
||
Accept: 'application/vnd.github+json',
|
||
},
|
||
})
|
||
|
||
if (!response.ok) {
|
||
throw new Error(`Failed to fetch commit statuses: ${response.status} ${response.statusText}`)
|
||
}
|
||
|
||
const statuses = await response.json()
|
||
|
||
return statuses
|
||
.filter((status) => status.context === STATUS_CONTEXT)
|
||
.sort((a, b) => new Date(b.created_at).getTime() - new Date(a.created_at).getTime())[0]
|
||
}
|
||
|
||
async function resolveDeploymentUrl(targetUrl, vercelToken, teamId) {
|
||
const rawId = targetUrl.split('/').filter(Boolean).pop()
|
||
if (!rawId) {
|
||
throw new Error(`Could not parse a deployment ID from target_url: ${targetUrl}`)
|
||
}
|
||
const deploymentId = rawId.startsWith('dpl_') ? rawId : `dpl_${rawId}`
|
||
|
||
const url = teamId
|
||
? `https://api.vercel.com/v13/deployments/${deploymentId}?teamId=${teamId}`
|
||
: `https://api.vercel.com/v13/deployments/${deploymentId}`
|
||
|
||
const response = await fetch(url, {
|
||
headers: { Authorization: `Bearer ${vercelToken}` },
|
||
})
|
||
|
||
if (!response.ok) {
|
||
throw new Error(
|
||
`Failed to resolve Vercel deployment ${deploymentId}: ${response.status} ${response.statusText}`
|
||
)
|
||
}
|
||
|
||
const deployment = await response.json()
|
||
return `https://${deployment.url}`
|
||
}
|
||
|
||
function writeOutput(name, value) {
|
||
const outputFile = process.env.GITHUB_OUTPUT
|
||
if (!outputFile) {
|
||
throw new Error('GITHUB_OUTPUT environment variable is required')
|
||
}
|
||
appendFileSync(outputFile, `${name}=${value}\n`)
|
||
}
|
||
|
||
async function main() {
|
||
const repository = process.env.GITHUB_REPOSITORY
|
||
const sha = process.env.HEAD_SHA
|
||
const githubToken = process.env.GITHUB_TOKEN
|
||
const vercelToken = process.env.VERCEL_TOKEN
|
||
const teamId = process.env.VERCEL_TEAM_ID
|
||
|
||
if (!repository) throw new Error('GITHUB_REPOSITORY environment variable is required')
|
||
if (!sha) throw new Error('HEAD_SHA environment variable is required')
|
||
if (!githubToken) throw new Error('GITHUB_TOKEN environment variable is required')
|
||
if (!vercelToken) throw new Error('VERCEL_TOKEN environment variable is required')
|
||
|
||
const start = Date.now()
|
||
|
||
for (;;) {
|
||
const latest = await fetchLatestStatus(repository, sha, githubToken)
|
||
|
||
if (latest?.state === 'success') {
|
||
if (!latest.target_url) {
|
||
throw new Error(
|
||
'Vercel docs commit status succeeded but had no target_url to resolve a deployment from'
|
||
)
|
||
}
|
||
const deploymentUrl = await resolveDeploymentUrl(latest.target_url, vercelToken, teamId)
|
||
writeOutput('deployment-url', deploymentUrl)
|
||
return
|
||
}
|
||
|
||
if (latest?.state === 'failure' || latest?.state === 'error') {
|
||
throw new Error(`Vercel docs deployment failed (commit status: ${latest.state})`)
|
||
}
|
||
|
||
if (Date.now() - start > TIMEOUT_MS) {
|
||
throw new Error('Timed out after 900s waiting for the Vercel docs preview deployment')
|
||
}
|
||
|
||
await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL_MS))
|
||
}
|
||
}
|
||
|
||
main().catch((error) => {
|
||
console.error('Fatal error:', error)
|
||
process.exit(1)
|
||
})
|