Skip to content

Commit 8cc5b52

Browse files
snomiaoclaudeDrJKL
authored
refactor: reorganize GitHub workflows with consistent naming convention (#5891)
## Summary This PR implements a systematic naming convention for all GitHub workflows to improve organization and discoverability. All 22 workflows have been renamed and grouped by logical categories with consistent prefixes. ## Changes ### Naming Convention - **`ci-*`**: Continuous Integration workflows (testing, linting, validation) - **`pr-*`**: PR-specific automation triggered by labels - **`release-*`**: Release management workflows - **`types-*`**: TypeScript type generation workflows - **`i18n-*`**: Internationalization workflows ### Key Renames - `tests-ci.yaml` → `ci-tests-e2e.yaml` - `vitest-tests.yaml` → `ci-tests-unit.yaml` - `storybook-and-chromatic-ci.yaml` → `ci-tests-storybook.yaml` - `auto-backport.yaml` → `pr-backport.yaml` - `claude-pr-review.yml` → `pr-claude-review.yaml` - `version-bump.yaml` → `release-version-bump.yaml` - `publish-frontend-types.yaml` → `release-npm-types.yaml` - `create-dev-pypi-package.yaml` → `release-pypi-dev.yaml` ### Test Workflow Improvements - Grouped all test workflows under `ci-tests-*` pattern - Fork-safe deployment workflows: `ci-tests-e2e-forks.yaml`, `ci-tests-storybook-forks.yaml` - Added comments explaining fork deployment security workarounds ### Documentation - Added comprehensive `.github/workflows/README.md` - Documents naming conventions, best practices, and workflow organization - Includes trigger patterns and external dependencies ## Benefits 1. **Better Organization**: Workflows are now grouped logically by prefix 2. **Improved Discoverability**: Easy to find related workflows 3. **Consistent Naming**: All workflows follow the same pattern 4. **Clear Purpose**: Workflow names immediately indicate their function 5. **Maintainable**: README provides guidelines for future workflows ## Test Plan - [x] All workflow cross-references updated - [x] Display names match new file names - [x] Fork deployment workflows properly reference main workflows - [x] Release workflows reference correct npm types workflow - [x] All workflows retain original functionality 🤖 Generated with [Claude Code](https://claude.ai/code) ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-5891-refactor-reorganize-GitHub-workflows-with-consistent-naming-convention-2806d73d365081febe47c7511bf0507e) by [Unito](https://www.unito.io) --------- Co-authored-by: Claude <[email protected]> Co-authored-by: Alexander Brown <[email protected]>
1 parent 03681a1 commit 8cc5b52

23 files changed

+60
-27
lines changed

.github/workflows/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# GitHub Workflows
2+
3+
## Naming Convention
4+
5+
Workflow files follow a consistent naming pattern: `<prefix>-<descriptive-name>.yaml`
6+
7+
### Category Prefixes
8+
9+
| Prefix | Purpose | Example |
10+
| ---------- | ----------------------------------- | ------------------------------------ |
11+
| `ci-` | Testing, linting, validation | `ci-tests-e2e.yaml` |
12+
| `release-` | Version management, publishing | `release-version-bump.yaml` |
13+
| `pr-` | PR automation (triggered by labels) | `pr-claude-review.yaml` |
14+
| `api-` | External Api type generation | `api-update-registry-api-types.yaml` |
15+
| `i18n-` | Internationalization updates | `i18n-update-core.yaml` |
16+
17+
## Documentation
18+
19+
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.
20+
21+
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).

.github/workflows/update-electron-types.yaml renamed to .github/workflows/api-update-electron-api-types.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Update Electron Types
1+
name: 'Api: Update Electron API Types'
2+
description: 'When upstream electron API is updated, click dispatch to update the TypeScript type definitions in this repo'
23

34
on:
45
workflow_dispatch:

.github/workflows/update-comfyui-manager-api-types.yaml renamed to .github/workflows/api-update-manager-api-types.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Update ComfyUI-Manager API Types
1+
name: 'Api: Update Manager API Types'
2+
description: 'When upstream ComfyUI-Manager API is updated, click dispatch to update the TypeScript type definitions in this repo'
23

34
on:
45
# Manual trigger

.github/workflows/update-comfy-registry-api-types.yaml renamed to .github/workflows/api-update-registry-api-types.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Update Comfy Registry API Types
1+
name: 'Api: Update Registry API Types'
2+
description: 'When upstream comfy-api is updated, click dispatch to update the TypeScript type definitions in this repo'
23

34
on:
45
# Manual trigger

.github/workflows/validate-json.yaml renamed to .github/workflows/ci-json-validation.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Validate JSON
1+
name: "CI: JSON Validation"
2+
description: "Validates JSON syntax in all tracked .json files (excluding tsconfig*.json) using jq"
23

34
on:
45
push:

.github/workflows/lint-and-format.yaml renamed to .github/workflows/ci-lint-format.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Lint and Format
1+
name: "CI: Lint Format"
2+
description: "Linting and code formatting validation for pull requests"
23

34
on:
45
pull_request:

.github/workflows/devtools-python-check.yaml renamed to .github/workflows/ci-python-validation.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Devtools Python Check
1+
name: "CI: Python Validation"
2+
description: "Validates Python code in tools/devtools directory"
23

34
on:
45
pull_request:

.github/workflows/pr-playwright-deploy-forks.yaml renamed to .github/workflows/ci-tests-e2e-forks.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
name: PR Playwright Deploy (Forks)
1+
name: "CI: Tests E2E (Deploy for Forks)"
2+
description: "Deploys test results from forked PRs (forks can't access deployment secrets)"
23

34
on:
45
workflow_run:
5-
workflows: ["Tests CI"]
6+
workflows: ["CI: Tests E2E"]
67
types: [requested, completed]
78

89
env:

.github/workflows/tests-ci.yaml renamed to .github/workflows/ci-tests-e2e.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Tests CI
1+
name: "CI: Tests E2E"
2+
description: "End-to-end testing with Playwright across multiple browsers, deploys test reports to Cloudflare Pages"
23

34
on:
45
push:

.github/workflows/pr-storybook-deploy-forks.yaml renamed to .github/workflows/ci-tests-storybook-forks.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
name: PR Storybook Deploy (Forks)
1+
name: "CI: Tests Storybook (Deploy for Forks)"
2+
description: "Deploys Storybook previews from forked PRs (forks can't access deployment secrets)"
23

34
on:
45
workflow_run:
5-
workflows: ['Storybook and Chromatic CI']
6+
workflows: ["CI: Tests Storybook"]
67
types: [requested, completed]
78

89
env:

0 commit comments

Comments
 (0)