mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-04 13:12:10 +00:00
## Summary Make the website preview URL stable per PR and make deployments show up correctly in the Vercel dashboard. ## Changes - **What**: - Pass git metadata (`githubCommitRef`, `githubCommitSha`, `githubCommitAuthorLogin`, `githubCommitMessage`, `githubPrId`, `githubRepo`) via `vercel deploy --meta` so deployments group by branch/PR in the dashboard and pick up branch-scoped env vars. - Alias each preview deploy to a stable per-PR hostname: `comfy-website-preview-pr-<N>.vercel.app`. URL no longer changes between pushes on the same PR. - PR comment now shows the stable URL prominently, the per-commit URL as subtext, plus a last-updated timestamp and short SHA so reviewers can tell if the preview is current. - User-controlled PR fields routed through env vars (no shell interpolation of untrusted strings). ## Review Focus - `PREVIEW_ALIAS_PREFIX` is set to `comfy-website-preview` — confirm this subdomain pattern is free within the Vercel team (first deploy will claim it). - Production job is untouched. - `vercel.json` keeps `github.enabled: false` — intentional, we stay CLI-driven. ### Known limitation (out of scope) Vercel Shareable Links are bound to a specific deployment ID. Aliasing the stable hostname to a new deployment does **not** carry over previously-issued share links. If the team needs share links to persist across pushes, follow-up options: Protection Bypass for Automation (project-level token) or Deployment Protection Exceptions (Pro+). ### Follow-ups - Optional `vercel alias rm` on PR close to clean up stale aliases. ## Screenshots (if applicable) N/A — CI config only. Verification will land on this PR's own preview run. ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-11478-ci-stabilize-Vercel-website-preview-URLs-per-PR-3486d73d3650815ab24be1f7895cecc5) by [Unito](https://www.unito.io) --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
159 lines
5.0 KiB
YAML
159 lines
5.0 KiB
YAML
---
|
|
name: 'CI: Vercel Website Preview'
|
|
|
|
on:
|
|
pull_request:
|
|
types: [opened, synchronize, reopened]
|
|
paths:
|
|
- 'apps/website/**'
|
|
- 'packages/design-system/**'
|
|
- 'packages/tailwind-utils/**'
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- 'apps/website/**'
|
|
- 'packages/design-system/**'
|
|
- 'packages/tailwind-utils/**'
|
|
|
|
env:
|
|
VERCEL_ORG_ID: ${{ secrets.VERCEL_WEBSITE_ORG_ID }}
|
|
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_WEBSITE_PROJECT_ID }}
|
|
VERCEL_TOKEN: ${{ secrets.VERCEL_WEBSITE_TOKEN }}
|
|
VERCEL_SCOPE: comfyui
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
deploy-preview:
|
|
if: github.event_name == 'pull_request'
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: read
|
|
env:
|
|
ALIAS_HOST: comfy-website-preview-pr-${{ github.event.pull_request.number }}.vercel.app
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Install pnpm
|
|
uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v4.4.0
|
|
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version-file: '.nvmrc'
|
|
|
|
- name: Install Vercel CLI
|
|
run: npm install --global vercel@latest
|
|
|
|
- name: Pull Vercel environment information
|
|
run: vercel pull --yes --environment=preview
|
|
|
|
- name: Build project artifacts
|
|
run: vercel build
|
|
|
|
- name: Fetch head commit metadata
|
|
id: head-commit
|
|
uses: actions/github-script@v8
|
|
with:
|
|
script: |
|
|
const { data } = await github.rest.repos.getCommit({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
ref: context.payload.pull_request.head.sha,
|
|
})
|
|
const author = data.author?.login || data.commit.author?.name || ''
|
|
const message = (data.commit.message || '').split('\n', 1)[0]
|
|
core.setOutput('author', author)
|
|
core.setOutput('message', message)
|
|
|
|
- name: Deploy project artifacts to Vercel
|
|
id: deploy
|
|
env:
|
|
GIT_COMMIT_REF: ${{ github.event.pull_request.head.ref }}
|
|
GIT_COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
|
|
GIT_AUTHOR_LOGIN: ${{ steps.head-commit.outputs.author }}
|
|
GIT_COMMIT_MESSAGE: ${{ steps.head-commit.outputs.message }}
|
|
GIT_PR_ID: ${{ github.event.pull_request.number }}
|
|
GIT_REPO: ${{ github.repository }}
|
|
run: |
|
|
URL=$(vercel deploy --prebuilt \
|
|
--meta githubCommitRef="$GIT_COMMIT_REF" \
|
|
--meta githubCommitSha="$GIT_COMMIT_SHA" \
|
|
--meta githubCommitAuthorLogin="$GIT_AUTHOR_LOGIN" \
|
|
--meta githubCommitMessage="$GIT_COMMIT_MESSAGE" \
|
|
--meta githubPrId="$GIT_PR_ID" \
|
|
--meta githubRepo="$GIT_REPO")
|
|
echo "url=$URL" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Alias deployment to stable PR hostname
|
|
id: alias-set
|
|
continue-on-error: true
|
|
env:
|
|
DEPLOY_URL: ${{ steps.deploy.outputs.url }}
|
|
run: |
|
|
vercel alias set "$DEPLOY_URL" "$ALIAS_HOST" --scope="$VERCEL_SCOPE"
|
|
|
|
- name: Publish preview outputs
|
|
env:
|
|
DEPLOY_URL: ${{ steps.deploy.outputs.url }}
|
|
ALIAS_OK: ${{ steps.alias-set.outcome == 'success' }}
|
|
run: |
|
|
if [[ "$ALIAS_OK" == "true" ]]; then
|
|
STABLE_URL="https://$ALIAS_HOST"
|
|
else
|
|
STABLE_URL="$DEPLOY_URL"
|
|
fi
|
|
mkdir -p temp/vercel-preview
|
|
echo "$DEPLOY_URL" > temp/vercel-preview/url.txt
|
|
echo "$STABLE_URL" > temp/vercel-preview/stable-url.txt
|
|
{
|
|
echo "**Preview:** $STABLE_URL"
|
|
if [[ "$ALIAS_OK" == "true" ]]; then
|
|
echo "**This commit:** $DEPLOY_URL"
|
|
else
|
|
echo "_Stable alias update failed — URL reflects this commit only._"
|
|
fi
|
|
} >> "$GITHUB_STEP_SUMMARY"
|
|
|
|
- name: Upload preview metadata
|
|
uses: actions/upload-artifact@v6
|
|
with:
|
|
name: vercel-preview
|
|
path: temp/vercel-preview
|
|
|
|
deploy-production:
|
|
if: github.event_name == 'push'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Install pnpm
|
|
uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v4.4.0
|
|
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version-file: '.nvmrc'
|
|
|
|
- name: Install Vercel CLI
|
|
run: npm install --global vercel@latest
|
|
|
|
- name: Pull Vercel environment information
|
|
run: vercel pull --yes --environment=production
|
|
|
|
- name: Build project artifacts
|
|
run: vercel build --prod
|
|
|
|
- name: Deploy project artifacts to Vercel
|
|
id: deploy
|
|
run: |
|
|
URL=$(vercel deploy --prebuilt --prod)
|
|
echo "url=$URL" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Add deployment URL to summary
|
|
run: echo "**Production:** ${{ steps.deploy.outputs.url }}" >> "$GITHUB_STEP_SUMMARY"
|