-
Notifications
You must be signed in to change notification settings - Fork 388
CI: Standardize workflow triggering and add automated documentation generation #6098
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- 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 <[email protected]>
- Extract duplicate label checking into addUniqueLabel helper - Improve comments explaining trigger filtering logic - Clarify which triggers are shown in Quick Reference vs detailed sections Co-authored-by: snomiao <[email protected]>
…Comfy-Org/ComfyUI_frontend into copilot/standardize-triggering-and-docs
🎨 Storybook Build Status✅ Build completed successfully! ⏰ Completed at: 10/19/2025, 02:55:57 AM UTC 🔗 Links🎉 Your Storybook is ready for review! |
🎭 Playwright Test Results⏰ Completed at: 10/19/2025, 03:09:48 AM UTC 📈 Summary
📊 Test Reports by Browser
🎉 Click on the links above to view detailed test results for each browser configuration. |
changed too many files |
Bundle Size ReportApp Entry PointsMain application bundles
Category Total: 11.7 MB Core ViewsMajor application views and screens
Category Total: 722 kB UI PanelsSettings and configuration panels
Category Total: 74.8 kB ServicesBusiness logic and services
Category Total: 10 kB UtilitiesHelper functions and utilities
Category Total: 1.07 kB OtherUncategorized bundles
Category Total: 1.12 kB Overall Total Size: 12.5 MB |
Overview
This PR implements automated workflow documentation generation and standardization as requested in issue #5987. All 25 GitHub Actions workflows now have consistent metadata, and documentation is automatically generated and kept in sync via CI.
Problem
The repository had grown to 25 workflows with inconsistent documentation:
description
fieldsSolution
1. Standardized All Workflows
Added
description
fields to all workflows following a consistent pattern:2. Created Automation Script
scripts/cicd/generate-workflow-docs.ts
- A TypeScript script that:.github/workflows/
github.event.label.name == 'label-name'
contains(github.event.pull_request.labels.*.name, 'label-name')
label_trigger: "label-name"
(for Claude action)startsWith(github.event.comment.body, '/command')
Usage:
pnpm workflow:docs
3. Auto-Generated Documentation
.github/workflows/README.md
now includes:needs-backport
- Automatically backports merged PRsclaude-review
- AI-powered code reviewNew Browser Test Expectations
- Update Playwright snapshotsRelease
- Triggers 3 release-related workflows4. CI Validation
ci-workflow-docs.yaml
ensures documentation stays current:Benefits
Label-Triggered Workflows Detected
The automation successfully identified and documented these label triggers:
Testing
Usage for Maintainers
When adding or modifying workflows:
name
anddescription
fieldspnpm workflow:docs
to regenerate documentationFixes #5987
Original prompt
Fixes #5987
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.
┆Issue is synchronized with this Notion page by Unito