mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-03 06:47:33 +00:00
ea4686a52c
- Add descriptive comments to key workflow files explaining purpose and triggers - Simplify workflows README.md to focus on naming convention only - Remove detailed workflow descriptions that can get out of date - Point users to individual workflow files for current documentation Addresses review feedback: documentation can get out of date quickly, put comments into workflows themselves with single example in README. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
21 lines
967 B
Markdown
21 lines
967 B
Markdown
# 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` |
|
|
| `types-` | TypeScript type generation | `types-registry-api.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](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows). |