Skip to content

Commit a9653ba

Browse files
Remove unsupported workflow description fields (#6881)
## Summary Remove top-level `description` keys from workflows because they are not valid in GitHub Actions workflow syntax (see https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax?utm_source=chatgpt.com). ## Changes - **What**: delete the unsupported `description:` field from all workflow YAMLs under `.github/workflows/`. ## Review Focus - Confirm workflows still show intended names and triggers without the invalid `description` metadata. ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-6881-Remove-unsupported-workflow-description-fields-2b56d73d365081ed9f20eb7f57956bc6) by [Unito](https://www.unito.io)
1 parent 30bafcd commit a9653ba

16 files changed

+16
-17
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
# Description: When upstream electron API is updated, click dispatch to update the TypeScript type definitions in this repo
12
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'
33

44
on:
55
workflow_dispatch:

.github/workflows/api-update-manager-api-types.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
# Description: When upstream ComfyUI-Manager API is updated, click dispatch to update the TypeScript type definitions in this repo
12
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'
33

44
on:
55
# Manual trigger

.github/workflows/api-update-registry-api-types.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
# Description: When upstream comfy-api is updated, click dispatch to update the TypeScript type definitions in this repo
12
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'
33

44
on:
55
# Manual trigger

.github/workflows/ci-json-validation.yaml

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

44
on:
55
push:

.github/workflows/ci-lint-format.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
# Description: Linting and code formatting validation for pull requests
12
name: "CI: Lint Format"
2-
description: "Linting and code formatting validation for pull requests"
33

44
on:
55
pull_request:

.github/workflows/ci-python-validation.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
# Description: Validates Python code in tools/devtools directory
12
name: "CI: Python Validation"
2-
description: "Validates Python code in tools/devtools directory"
33

44
on:
55
pull_request:

.github/workflows/ci-tests-e2e-forks.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
# Description: Deploys test results from forked PRs (forks can't access deployment secrets)
12
name: "CI: Tests E2E (Deploy for Forks)"
2-
description: "Deploys test results from forked PRs (forks can't access deployment secrets)"
33

44
on:
55
workflow_run:

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

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

44
on:
55
push:

.github/workflows/ci-tests-storybook-forks.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
# Description: Deploys Storybook previews from forked PRs (forks can't access deployment secrets)
12
name: "CI: Tests Storybook (Deploy for Forks)"
2-
description: "Deploys Storybook previews from forked PRs (forks can't access deployment secrets)"
33

44
on:
55
workflow_run:

.github/workflows/ci-tests-storybook.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1+
# Description: Builds Storybook and runs visual regression testing via Chromatic, deploys previews to Cloudflare Pages
12
name: "CI: Tests Storybook"
2-
description: "Builds Storybook and runs visual regression testing via Chromatic, deploys previews to Cloudflare Pages"
33

44
on:
55
workflow_dispatch: # Allow manual triggering
66
pull_request:
7-
branches: [main]
87

98
jobs:
109
# Post starting comment for non-forked PRs

0 commit comments

Comments
 (0)