mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-14 01:36:14 +00:00
836cab1b38
## Summary Vercel's auto-deploy triggers on every PR because files outside workspace packages (e.g. `browser_tests/`, `src/`) are treated as global changes by the monorepo skip logic. ## Changes - **What**: Replace Vercel's GitHub integration with a GitHub Action (`ci-vercel-website-preview.yaml`) that uses `paths:` filtering to only deploy when `apps/website/`, `packages/design-system/`, or `packages/tailwind-utils/` change. Add `vercel.json` with `github.enabled: false` to disable Vercel's automatic GitHub integration. ## Setup required after merge Three GitHub repo secrets are needed. All secrets are scoped per-project using the `VERCEL_WEBSITE_*` prefix. Future Vercel projects would follow the same convention (e.g. `VERCEL_DOCS_*`). ### Step 1: Create a Vercel API Token 1. Go to [vercel.com/account/tokens](https://vercel.com/account/tokens) 2. Click **Create Token** 3. Fill in the form: - **Token Name**: `github-actions-website` - **Scope**: Select the **Comfy-Org** team (not "Full Account" — scope it to the team that owns the project) - **Expiration**: Choose **No Expiration** (or set a long expiration like 1 year — if it expires the workflow will silently fail) 4. Click **Create** 5. **Copy the token immediately** — it is only shown once ### Step 2: Get Vercel Org ID and Project ID 1. Go to [vercel.com/comfyui/website-frontend/settings](https://vercel.com/comfyui/website-frontend/settings) 2. Scroll down to the **Project ID** field — copy this value 3. Go to [vercel.com/teams/comfyui/settings](https://vercel.com/teams/comfyui/settings) (Team Settings → General) 4. Find the **Vercel ID** field (also called Team ID / Org ID) — copy this value ### Step 3: Add secrets to GitHub 1. Go to [github.com/Comfy-Org/ComfyUI_frontend/settings/secrets/actions](https://github.com/Comfy-Org/ComfyUI_frontend/settings/secrets/actions) 2. Click **New repository secret** and add each of the three secrets: | Secret name | Value | |---|---| | `VERCEL_WEBSITE_TOKEN` | The token from Step 1 | | `VERCEL_WEBSITE_ORG_ID` | The team/org ID from Step 2 | | `VERCEL_WEBSITE_PROJECT_ID` | The project ID from Step 2 | > **Note:** The `vercel.json` added by this PR (`github.enabled: false`) automatically disables Vercel's built-in auto-deploy — no dashboard changes needed. ## Review Focus - Verify the `paths:` filter covers all dependencies of `apps/website` - Confirm the PR comment logic is sound (creates once, updates on subsequent pushes) --------- Co-authored-by: Alexander Brown <drjkl@comfy.org> Co-authored-by: DrJKL <DrJKL0424@gmail.com> Co-authored-by: Amp <amp@ampcode.com>
GitHub Workflows
Naming Convention
Workflow files follow a consistent naming pattern: <prefix>-<descriptive-name>.yaml
Category Prefixes
| Prefix | Purpose | Example |
|---|---|---|
ci- |
Testing, linting, validation | ci-tests-e2e.yaml |
release- |
Version management, publishing | release-version-bump.yaml |
pr- |
PR automation (triggered by labels) | pr-claude-review.yaml |
api- |
External Api type generation | api-update-registry-api-types.yaml |
i18n- |
Internationalization updates | i18n-update-core.yaml |
Documentation
Each workflow file contains comments explaining its purpose, triggers, and behavior. For specific details about what each workflow does, refer to the comments at the top of each .yaml file.
For GitHub Actions documentation, see Events that trigger workflows.