CI: Split CircleCI config into multiple files #32025

ghengeveld · 2025-07-11T22:08:51Z

Closes #

What I did

Reorganized our CircleCI config by splitting it into separate files and then use config packing to generate the final config.yml.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

stories
unit tests
integration tests
end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
- bug: Internal changes that fixes incorrect behavior.
- maintenance: User-facing maintenance tasks.
- dependencies: Upgrading (sometimes downgrading) dependencies.
- build: Internal-facing build tooling & test updates. Will not show up in release changelog.
- cleanup: Minor cleanup style change. Will not show up in release changelog.
- documentation: Documentation only changes. Will not show up in release changelog.
- feature request: Introducing a new feature.
- BREAKING CHANGE: Changes that break compatibility in some way with current major version.
- other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Splits monolithic CircleCI configuration into multiple modular files using CircleCI's config packing feature, significantly improving maintainability without changing core functionality.

Split configuration into specialized files under .circleci/src/ for workflows, jobs, executors, commands, and parameters
Added comprehensive documentation in .circleci/README.md explaining configuration structure and local testing procedures
Preserved all existing CI functionality including build chains, test matrices, and parallelization settings
Added TODOs for temporarily disabled flaky jobs (bench-sandboxes, test-runner-dev)
Maintained workspace persistence and caching strategies across all jobs

greptile-apps

_{39 files reviewed, 18 comments}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-07-11T22:09:27Z

.circleci/src/jobs/e2e-ui.yml

+  - store_test_results:
+      path: test-results


logic: Test results path should match working directory path for consistency. Change to test-storybooks/portable-stories-kitchen-sink/react/test-results

.circleci/src/executors/sb_playwright.yml

greptile-apps · 2025-07-11T22:09:27Z

.circleci/src/jobs/bench-packages.yml

+              done
+              yarn bench-packages --base-branch << pipeline.parameters.ghBaseBranch >> --pull-request << pipeline.parameters.ghPrNumber >> --upload
+  # if there is a NOT a base branch OR NOT a PR number in parameters, just upload benchmarks for the branch
+  # this happens when runned directly on branches, like next or main


syntax: Typo: 'runned' should be 'run'

Suggested change

# this happens when runned directly on branches, like next or main

# this happens when run directly on branches, like next or main

greptile-apps · 2025-07-11T22:09:27Z

.circleci/src/jobs/chromatic-internal-storybook.yml

+  - store_test_results:
+      path: test-results


style: Test results directory should be prefixed with a unique identifier like 'chromatic-' to avoid conflicts with other test jobs

greptile-apps · 2025-07-11T22:09:28Z

.circleci/src/jobs/bench-sandboxes.yml

+      name: Uploading results
+      command: yarn upload-bench $(yarn get-template --cadence << pipeline.parameters.workflow >> --task bench) << pipeline.parameters.ghPrNumber >> << pipeline.parameters.ghBaseBranch >>
+  - report-workflow-on-failure:
+      template: $(yarn get-template --cadence << pipeline.parameters.workflow >> --task bench)


syntax: Template parameter in report-workflow-on-failure should be quoted to handle paths with spaces.

greptile-apps · 2025-07-11T22:09:31Z

.circleci/src/workflows/merged.yml

+  - bench-packages:
+      requires:
+        - build
+  - check


logic: The 'check' job has no dependencies specified, while most other jobs require 'build'. Consider whether this is intentional.

greptile-apps · 2025-07-11T22:09:31Z

.circleci/src/jobs/test-init-features.yml

+        cd ../../
+        mkdir features-1
+        cd features-1


logic: Use mktemp or unique directory naming to prevent conflicts in parallel runs

greptile-apps · 2025-07-11T22:09:31Z

.circleci/config.yml

+                            IN_STORYBOOK_SANDBOX: true
+                            STORYBOOK_DISABLE_TELEMETRY: true
+                            STORYBOOK_INIT_EMPTY_TYPE: << parameters.template >>


style: Consider moving common environment variables like STORYBOOK_DISABLE_TELEMETRY and IN_STORYBOOK_SANDBOX into job parameters to avoid repetition

greptile-apps · 2025-07-11T22:09:32Z

.circleci/src/jobs/test-init-empty.yml

+            name: Storybook init from empty directory (NPM)
+            command: |
+              cd code
+              yarn local-registry --open &


logic: Background process not properly handled - should add trap to cleanup local-registry process on exit

greptile-apps · 2025-07-11T22:09:32Z

.circleci/config.yml

                command: |
-                  cd code
-                  yarn local-registry --open &
-                  cd ../../
-                  mkdir empty-<< parameters.template >>
-                  cd empty-<< parameters.template >>
-                  npm i -g pnpm
-                  pnpm config set registry http://localhost:6001
-                  pnpm dlx storybook init --yes --package-manager pnpm
-                  pnpm run storybook --smoke-test
+                    TEMPLATE=$(yarn get-template --cadence << pipeline.parameters.workflow >> --task test-runner)
+                    cd sandbox/$(yarn get-sandbox-dir --template $TEMPLATE) && yarn
+                name: Install sandbox dependencies
+            - start-event-collector
+            - run:
+                command: yarn task --task test-runner --template $(yarn get-template --cadence << pipeline.parameters.workflow >> --task test-runner) --no-link --start-from=never --junit
                environment:
-                  IN_STORYBOOK_SANDBOX: true
-                  STORYBOOK_INIT_EMPTY_TYPE: << parameters.template >>
-                  STORYBOOK_DISABLE_TELEMETRY: true
-      - when:
-          condition:
-            equal: ['react-vite-ts', << parameters.template >>]
-          steps:
+                    STORYBOOK_TELEMETRY_DEBUG: 1
+                    STORYBOOK_TELEMETRY_URL: http://localhost:6007/event-log
+                name: Running Test Runner
+            - run:
+                command: yarn --cwd scripts jiti ./event-log-checker.ts test-run $(yarn get-template --cadence << pipeline.parameters.workflow >> --task test-runner)
+                name: Check Telemetry


style: Consider extracting telemetry check commands into a reusable command since they're used in multiple jobs (test-runner, vitest-integration)

nx-cloud · 2025-07-11T22:10:35Z

View your CI Pipeline Execution ↗ for commit 7128fce

Command	Status	Duration	Result
`nx run-many -t build --parallel=3`	✅ Succeeded	1m 14s	View ↗

☁️ Nx Cloud last updated this comment at 2025-07-14 08:44:48 UTC

ghengeveld requested a review from ndelangen July 11, 2025 22:08

ghengeveld self-assigned this Jul 11, 2025

ghengeveld added build Internal-facing build tooling & test updates ci:normal labels Jul 11, 2025

greptile-apps bot reviewed Jul 11, 2025

View reviewed changes

valentinpalkovic added ci:daily Run the CI jobs that normally run in the daily job. and removed ci:normal labels Jul 14, 2025

valentinpalkovic approved these changes Jul 14, 2025

View reviewed changes

ghengeveld mentioned this pull request Jul 14, 2025

CI: Sort keys in CircleCI config.yml to prep for config packing #32033

Closed

8 tasks

ghengeveld changed the base branch from next to circleci-config-sort July 14, 2025 08:18

ghengeveld added 2 commits July 14, 2025 10:20

Split CircleCI config into multiple files, using config packing

72042bb

Formatting

7128fce

ghengeveld force-pushed the circleci-config-pack branch from 9f8ba24 to 7128fce Compare July 14, 2025 08:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

CI: Split CircleCI config into multiple files #32025

CI: Split CircleCI config into multiple files #32025

Uh oh!

ghengeveld commented Jul 11, 2025 •

edited by greptile-apps bot

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

greptile-apps bot Jul 11, 2025

Uh oh!

nx-cloud bot commented Jul 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

	# this happens when runned directly on branches, like next or main
	# this happens when run directly on branches, like next or main

Uh oh!

CI: Split CircleCI config into multiple files #32025

Are you sure you want to change the base?

CI: Split CircleCI config into multiple files #32025

Uh oh!

Conversation

ghengeveld commented Jul 11, 2025 • edited by greptile-apps bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

Greptile Summary

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

nx-cloud bot commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

ghengeveld commented Jul 11, 2025 •

edited by greptile-apps bot

Loading

nx-cloud bot commented Jul 11, 2025 •

edited

Loading