mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-03-13 09:00:16 +00:00
## Summary
Add support for deploying full ephemeral preview environments from
frontend PRs. This is the frontend-side half — it sends `pr_number` and
`variant` (cpu/gpu) in the dispatch payload, and adds a cleanup dispatch
on PR close/unlabel.
### Changes
- **`cloud-dispatch-build.yaml`** — Add `pr_number` and `variant` to the
`frontend-asset-build` dispatch payload. Variant is derived from which
preview label triggered the event (`preview-cpu` → cpu, else gpu).
- **`cloud-dispatch-cleanup.yaml`** (new) — Fire-and-forget dispatch of
`frontend-preview-cleanup` to the cloud repo when a frontend PR is
closed or has its preview label removed. Enables synchronized teardown.
### Companion PR
Cloud-side: Comfy-Org/cloud (creates the `deploy-frontend-preview` job,
extends the reconciler)
### How it works
1. Label a frontend PR with `preview`, `preview-cpu`, or `preview-gpu`
2. Assets build and upload to GCS (existing flow)
3. Cloud deploys a full ephemeral env at `fe-pr-{N}.testenvs.comfy.org`
using all `:main` service tags
4. Subsequent pushes update the frontend SHA via AppSet upsert
5. On close/unlabel, cleanup dispatch triggers immediate teardown
┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-9715-feat-dispatch-frontend-PR-preview-environments-to-cloud-31f6d73d3650819da1b5ca5ce419e06e)
by [Unito](https://www.unito.io)
87 lines
3.2 KiB
YAML
87 lines
3.2 KiB
YAML
---
|
|
# Dispatches a frontend-asset-build event to the cloud repo on push to
|
|
# cloud/* branches and main. The cloud repo handles the actual build,
|
|
# GCS upload, and secret management (Sentry, Algolia, GCS creds).
|
|
#
|
|
# This is fire-and-forget — it does NOT wait for the cloud workflow to
|
|
# complete. Status is visible in the cloud repo's Actions tab.
|
|
|
|
name: Cloud Frontend Build Dispatch
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- 'cloud/*'
|
|
- 'main'
|
|
pull_request:
|
|
types: [labeled, synchronize]
|
|
workflow_dispatch:
|
|
|
|
permissions: {}
|
|
|
|
concurrency:
|
|
group: cloud-dispatch-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
dispatch:
|
|
# Fork guard: prevent forks from dispatching to the cloud repo.
|
|
# For pull_request events, only dispatch for preview labels.
|
|
# - labeled: fires when a label is added; check the added label name.
|
|
# - synchronize: fires on push; check existing labels on the PR.
|
|
if: >
|
|
github.repository == 'Comfy-Org/ComfyUI_frontend' &&
|
|
(github.event_name != 'pull_request' ||
|
|
(github.event.action == 'labeled' &&
|
|
contains(fromJSON('["preview","preview-cpu","preview-gpu"]'), github.event.label.name)) ||
|
|
(github.event.action == 'synchronize' &&
|
|
(contains(github.event.pull_request.labels.*.name, 'preview') ||
|
|
contains(github.event.pull_request.labels.*.name, 'preview-cpu') ||
|
|
contains(github.event.pull_request.labels.*.name, 'preview-gpu'))))
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Build client payload
|
|
id: payload
|
|
env:
|
|
EVENT_NAME: ${{ github.event_name }}
|
|
PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
|
PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
|
|
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
ACTION: ${{ github.event.action }}
|
|
LABEL_NAME: ${{ github.event.label.name }}
|
|
PR_LABELS: ${{ toJson(github.event.pull_request.labels.*.name) }}
|
|
run: |
|
|
if [ "${EVENT_NAME}" = "pull_request" ]; then
|
|
REF="${PR_HEAD_SHA}"
|
|
BRANCH="${PR_HEAD_REF}"
|
|
|
|
# Derive variant from labels
|
|
VARIANT="gpu"
|
|
if [ "${ACTION}" = "labeled" ]; then
|
|
[ "${LABEL_NAME}" = "preview-cpu" ] && VARIANT="cpu"
|
|
else
|
|
# synchronize — check existing labels on the PR
|
|
echo "${PR_LABELS}" | grep -q '"preview-cpu"' && VARIANT="cpu"
|
|
fi
|
|
else
|
|
REF="${GITHUB_SHA}"
|
|
BRANCH="${GITHUB_REF_NAME}"
|
|
PR_NUMBER=""
|
|
VARIANT=""
|
|
fi
|
|
payload="$(jq -nc \
|
|
--arg ref "${REF}" \
|
|
--arg branch "${BRANCH}" \
|
|
--arg pr_number "${PR_NUMBER}" \
|
|
--arg variant "${VARIANT}" \
|
|
'{ref: $ref, branch: $branch, pr_number: $pr_number, variant: $variant}')"
|
|
echo "json=${payload}" >> "${GITHUB_OUTPUT}"
|
|
|
|
- name: Dispatch to cloud repo
|
|
uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 # v4.0.1
|
|
with:
|
|
token: ${{ secrets.CLOUD_DISPATCH_TOKEN }}
|
|
repository: Comfy-Org/cloud
|
|
event-type: frontend-asset-build
|
|
client-payload: ${{ steps.payload.outputs.json }}
|