-
Notifications
You must be signed in to change notification settings - Fork 378
refactor: reorganize GitHub workflows with consistent naming convention #5891
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
b578a42
676792c
7006800
2fcb840
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# GitHub Workflows Documentation | ||
|
||
## Naming Convention | ||
|
||
All workflow files follow a consistent naming pattern for improved organization and discoverability. | ||
|
||
### File Naming Format | ||
|
||
``` | ||
<prefix>-<descriptive-name>.yaml | ||
``` | ||
|
||
**Rules:** | ||
1. Use `.yaml` extension consistently (not `.yml`) | ||
2. Use lowercase letters only | ||
3. Use hyphens (`-`) as word separators | ||
4. Start with a category prefix (see below) | ||
5. Follow prefix with a descriptive name that clearly indicates the workflow's purpose | ||
|
||
### Category Prefixes | ||
|
||
| Prefix | Category | Purpose | Example | | ||
|--------|----------|---------|---------| | ||
| `ci-` | Continuous Integration | Testing, linting, validation workflows | `ci-tests-e2e.yaml` | | ||
| `release-` | Release Management | Version bumps, release branches, release drafts | `release-version-bump.yaml` | | ||
| `pr-` | PR Automation | PR-specific workflows triggered by labels | `pr-claude-review.yaml` | | ||
| `types-` | Type Generation | TypeScript type generation and updates | `types-registry-api.yaml` | | ||
| `i18n-` | Internationalization | Locale and translation updates | `i18n-update-core.yaml` | | ||
|
||
## Workflow Organization | ||
|
||
### Test Workflows (`ci-tests-*`) | ||
- `ci-tests-e2e.yaml` - End-to-end testing with Playwright | ||
- `ci-tests-unit.yaml` - Unit and component testing with Vitest | ||
- `ci-tests-storybook.yaml` - Storybook build and visual regression testing | ||
- `ci-tests-*-forks.yaml` - Fork-safe deployment workflows (deploy results without exposing secrets) | ||
Comment on lines
+34
to
+38
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This kind of documentation can get out of date really quickly. |
||
|
||
### PR Label Workflows (`pr-*`) | ||
These workflows are triggered when specific labels are added to PRs: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This would be a good place to link to GitHub's documentation. |
||
|
||
| Workflow | Trigger Label | Purpose | | ||
|----------|---------------|---------| | ||
| `pr-backport.yaml` | `needs-backport` | Cherry-pick PRs to release branches | | ||
| `pr-claude-review.yaml` | `claude-review` | AI-powered code review | | ||
| `pr-playwright-snapshots.yaml` | `New Browser Test Expectations` | Update visual test snapshots | | ||
snomiao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Workflow Triggers | ||
|
||
### Common Trigger Patterns | ||
|
||
| Trigger Type | Use Case | Example | | ||
|--------------|----------|---------| | ||
| `push` to main/master | Production CI/CD | Deploy to production | | ||
| `pull_request` | PR validation | Run tests, linting | | ||
| `workflow_dispatch` | Manual execution | On-demand deployments | | ||
| `repository_dispatch` | External triggers | API type updates | | ||
| `workflow_run` | Chain workflows | Fork deployments | | ||
| `schedule` | Periodic tasks | Nightly builds | | ||
| Label added | Conditional actions | Review requests, snapshots | | ||
|
||
### Branch Protection Patterns | ||
|
||
- **Main branches**: `main`, `master` | ||
- **Release branches**: `core/**`, `release/**` | ||
- **Development branches**: `dev/**`, `develop/**` | ||
- **Desktop branches**: `desktop/**` | ||
- **WIP exclusion**: `!**wip/**`, `!wip/**` | ||
|
||
## Best Practices | ||
snomiao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. **Consistency**: Always use the naming convention for new workflows | ||
2. **Documentation**: Update this README when adding new prefixes or patterns | ||
3. **Permissions**: Use minimal required permissions for security | ||
4. **Caching**: Leverage GitHub Actions cache for dependencies and build artifacts | ||
5. **Concurrency**: Use concurrency groups to prevent duplicate runs | ||
6. **Secrets**: Never hardcode secrets; use GitHub Secrets | ||
7. **Fork Support**: Consider fork limitations when designing workflows | ||
8. **Error Handling**: Include proper error handling and status checks | ||
9. **Reusability**: Use workflow_call for shared logic across workflows | ||
|
||
## External Dependencies | ||
|
||
- **Cloudflare Pages**: Deployment platform for previews and test reports | ||
- **Chromatic**: Visual regression testing for Storybook | ||
- **OpenAI API**: Translation generation for i18n workflows | ||
- **PyPI**: Python package distribution | ||
- **npm Registry**: TypeScript types distribution | ||
- **Claude API**: AI code review |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Validate JSON | ||
name: JSON Validation CI | ||
|
||
on: | ||
push: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Lint and Format | ||
name: Lint Format CI | ||
|
||
on: | ||
pull_request: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Devtools Python Check | ||
name: Python Validation CI | ||
|
||
on: | ||
pull_request: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Tests CI | ||
name: Tests E2E CI | ||
|
||
on: | ||
push: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Vitest Tests | ||
name: Tests Unit CI | ||
|
||
on: | ||
push: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Update Locales | ||
name: i18n Update Core | ||
|
||
on: | ||
# Manual dispatch for urgent translation updates | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Update Locales for given custom node repository | ||
name: i18n Update Custom Nodes | ||
|
||
on: | ||
workflow_dispatch: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Update Node Definitions Locales | ||
name: i18n Update Nodes | ||
|
||
on: | ||
workflow_dispatch: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Auto Backport | ||
name: PR Backport | ||
|
||
on: | ||
pull_request_target: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Claude PR Review | ||
name: PR Claude Review | ||
|
||
permissions: | ||
contents: read | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Create Release Branch | ||
name: Release Branch Create | ||
|
||
on: | ||
pull_request: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Publish Frontend Types | ||
name: Release NPM Types | ||
|
||
on: | ||
workflow_dispatch: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Create Dev PyPI Package | ||
name: Release PyPI Dev | ||
|
||
on: | ||
workflow_dispatch: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Version Bump | ||
name: Release Version Bump | ||
|
||
on: | ||
workflow_dispatch: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Update Electron Types | ||
name: Types Electron API | ||
|
||
on: | ||
workflow_dispatch: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Update ComfyUI-Manager API Types | ||
name: Types Manager API | ||
|
||
on: | ||
# Manual trigger | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Update Comfy Registry API Types | ||
name: Types Registry API | ||
|
||
on: | ||
# Manual trigger | ||
|
Uh oh!
There was an error while loading. Please reload this page.