Skip to content

Conversation

snomiao
Copy link
Member

@snomiao snomiao commented Oct 2, 2025

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.yamlci-tests-e2e.yaml
  • vitest-tests.yamlci-tests-unit.yaml
  • storybook-and-chromatic-ci.yamlci-tests-storybook.yaml
  • auto-backport.yamlpr-backport.yaml
  • claude-pr-review.ymlpr-claude-review.yaml
  • version-bump.yamlrelease-version-bump.yaml
  • publish-frontend-types.yamlrelease-npm-types.yaml
  • create-dev-pypi-package.yamlrelease-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

  • All workflow cross-references updated
  • Display names match new file names
  • Fork deployment workflows properly reference main workflows
  • Release workflows reference correct npm types workflow
  • All workflows retain original functionality

🤖 Generated with Claude Code

┆Issue is synchronized with this Notion page by Unito

- Implement systematic naming convention using category prefixes
- Group workflows logically: ci-, pr-, release-, types-, i18n-
- Rename all 22 workflows for better organization and discoverability
- Update workflow cross-references and display names
- Add comprehensive README.md with naming guidelines and best practices

Key changes:
- CI workflows: ci-tests-e2e, ci-tests-unit, ci-tests-storybook, etc.
- PR automation: pr-backport, pr-claude-review, pr-playwright-snapshots
- Release management: release-version-bump, release-npm-types, etc.
- Type generation: types-registry-api, types-manager-api, etc.
- Internationalization: i18n-update-core, i18n-update-nodes, etc.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Oct 2, 2025
@christian-byrne
Copy link
Contributor

This might break a lot of other things like branch protection rules

@DrJKL
Copy link
Contributor

DrJKL commented Oct 3, 2025

This might break a lot of other things like branch protection rules

These probably aren't the names I would have gone with, but this was my idea to make the actions a little more organized and make it easier to find related workflows.

The branch protection rules would almost definitely need to be updated, GitHub isn't great about noticing changes like that.

@christian-byrne
Copy link
Contributor

Should be fine as long as we update BP when merging. I think there's some other things like documentation, claude commands, and the PyPi and NPM auth stuff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants