mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-03 22:59:14 +00:00
feat: Improve workflow documentation generation
- Add detection for needs-backport and Release labels - Deduplicate label triggers in Quick Reference section - Generate Quick Reference dynamically from workflows - Show all label-triggered workflows with descriptions Co-authored-by: snomiao <7323030+snomiao@users.noreply.github.com>
This commit is contained in:
23
.github/workflows/README.md
vendored
23
.github/workflows/README.md
vendored
@@ -25,11 +25,14 @@ Workflow files follow a consistent naming pattern: `<prefix>-<descriptive-name>.
|
||||
## Quick Reference
|
||||
|
||||
For label-triggered workflows, add the corresponding label to a PR to trigger the workflow:
|
||||
- `claude-review` - Trigger AI-powered code review
|
||||
- `New Browser Test Expectations` - Update Playwright test snapshots
|
||||
- `New Browser Test Expectations` - Updates Playwright test snapshots when triggered by label or comment
|
||||
- `Release` - Triggers 3 workflows
|
||||
- `claude-review` - AI-powered code review triggered by adding the 'claude-review' label to a PR
|
||||
- `needs-backport` - Automatically backports merged PRs to release branches when 'needs-backport' label is applied
|
||||
|
||||
For manual workflows, use the "Run workflow" button in the Actions tab.
|
||||
|
||||
|
||||
## Workflow Details
|
||||
|
||||
|
||||
@@ -95,6 +98,14 @@ For manual workflows, use the "Run workflow" button in the Actions tab.
|
||||
|
||||
**Triggers:** pull_request, push
|
||||
|
||||
#### [`ci-workflow-docs.yaml`](./ci-workflow-docs.yaml)
|
||||
|
||||
**Name:** CI: Workflow Documentation
|
||||
|
||||
**Description:** Validates that workflow documentation is up-to-date with workflow files
|
||||
|
||||
**Triggers:** pull_request
|
||||
|
||||
|
||||
### PR
|
||||
|
||||
@@ -106,6 +117,8 @@ For manual workflows, use the "Run workflow" button in the Actions tab.
|
||||
|
||||
**Triggers:** workflow_dispatch (manual), pull_request_target (closed, labeled)
|
||||
|
||||
**Label Triggers:** `needs-backport`
|
||||
|
||||
#### [`pr-claude-review.yaml`](./pr-claude-review.yaml)
|
||||
|
||||
**Name:** PR: Claude Review
|
||||
@@ -137,6 +150,8 @@ For manual workflows, use the "Run workflow" button in the Actions tab.
|
||||
|
||||
**Triggers:** pull_request (closed)
|
||||
|
||||
**Label Triggers:** `Release`
|
||||
|
||||
#### [`release-draft-create.yaml`](./release-draft-create.yaml)
|
||||
|
||||
**Name:** Release Draft Create
|
||||
@@ -145,6 +160,8 @@ For manual workflows, use the "Run workflow" button in the Actions tab.
|
||||
|
||||
**Triggers:** pull_request (closed)
|
||||
|
||||
**Label Triggers:** `Release`
|
||||
|
||||
#### [`release-npm-types.yaml`](./release-npm-types.yaml)
|
||||
|
||||
**Name:** Release NPM Types
|
||||
@@ -234,6 +251,8 @@ For manual workflows, use the "Run workflow" button in the Actions tab.
|
||||
|
||||
**Triggers:** pull_request (closed)
|
||||
|
||||
**Label Triggers:** `Release`
|
||||
|
||||
#### [`publish-desktop-ui.yaml`](./publish-desktop-ui.yaml)
|
||||
|
||||
**Name:** Publish Desktop UI
|
||||
|
||||
Reference in New Issue
Block a user