chore: use circleci cli to package ci configurations #32462

cacieprins · 2025-09-10T19:43:19Z

Closes

Additional details

While the line count of the main workflows.yml has increased quite a bit, this is because circleci config pack unrolls/expands all anchors in the source yml files.

circleci config pack uses the FYAML convention to be able to break yaml files into smaller, easier to digest chunks.

This PR:

migrates workflows.yml to .circleci/src/workflows
defines a new pull-request workflow, which at the moment is identical to linux-x64 except it does not include references to any of the jobs excluded by the main build filters
migrates config.yml to .circleci/src/config
adds a husky pre-commit hook to pack directories in .circleci/src to a yaml file defined by the directory name in .circleci/
additionally, runs circleci config validate on these packed yml files, to ensure that they are valid circleci configs

Steps to test

How has the user experience changed?

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

…cleci config pack to compose them into the main workflows.yml file

cypress · 2025-09-12T16:02:24Z

cypress Run #65601

Run Properties: Passed #65601 • eab6571804: Merge commit 'stash' into use-pack-for-circle

Project	`cypress`
Branch Review	`use-pack-for-circle`
Run status	`Passed #65601`
Run duration	`21m 43s`
Commit	`eab6571804: Merge commit 'stash' into use-pack-for-circle`
Committer	`cypress-bot[bot]`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`2`
Pending	`28`
Skipped	`0`
Passing	`791`
View all changes introduced in this branch ↗︎

UI Coverage `62.34%`
Untested elements	`27`
Tested elements	`48`

Accessibility `99%`
Failed rules	`0 critical` `3 serious` `1 moderate` `0 minor`
Failed elements	`18`

.husky/pre-commit

cacieprins · 2025-09-16T15:35:14Z

packages/electron/test/open.spec.ts

@@ -278,7 +278,7 @@ describe('open', () => {
        errCb(err)

        expect(process.exit).toHaveBeenCalledWith(1)
-        // eslint-disable-next-line no-console
+


linting was failing without these changes

cacieprins · 2025-09-16T15:36:30Z

.circleci/src/workflows/workflows/pull-request.yml

+            value: << pipeline.git.branch >>
+    - not:
+        matches:
+            pattern: /^pull\/[0-9]+/


contributor prs still use the contributor linux-x64 workflow, for now. for an idea about how we can simplify that: #32494

that would be nice because not everything runs the same. It'd be nice to have that logic more clearly separated out.

… commit

AtofStryker · 2025-09-16T16:22:51Z

.circleci/src/workflows/@workflows.yml

@@ -0,0 +1,2844 @@
+version: 2.1
+
+chrome-stable-version: &chrome-stable-version "140.0.7339.127"


The github action likely needs to be updated that was originally updating the .circleci/workflow file for the latest browser version. We are also using the yaml package to format the config. I did some work to port it over in https://github.com/cypress-io/cypress/pull/30989/files so hopefully that paints enough context if/what needs to change

Updated the scripts & left a comment that updating them is necessary in 5fb5125

Might just want to verify this works after merge. I did run it, but there's no browser version updates so it didn't trigger the whole thing. https://github.com/cypress-io/cypress/actions/runs/17800753588

…ct file

jennifer-shehane

@cacieprins Can you add this branch to run the extended windows, binary, etc tests to ensure that workflow still works the same when you want it to run on your PR?

jennifer-shehane

I went through and compared the jobs run + required job chain in CircleCI on previous branches to this one. Everything is running the same (although I wasn't able to verify that the 'ready-to-release' job will run since the dependent jobs have not all passed at any point.)

jennifer-shehane · 2025-09-17T14:17:43Z

.circleci/src/config/jobs/verify-ci-should-run.yml

@@ -0,0 +1,49 @@
+resource_class: small


This strangely maxes out its resources checking out code. I wonder if this could be sped up with more. (I realize you didn't change this from before). https://app.circleci.com/pipelines/github/cypress-io/cypress/74784/workflows/2d0ba1d8-892a-4aee-9cac-b0d07ffd0700/jobs/3142881/resources

Oh, probably! We could switch this to medium. We could also do some custom git credential stuff and do a super shallow checkout - all we need is the target workflow file. The baked in checkout command does a pretty good job of doing the minimal, but it can't carve it down that far.

I'd suggest we just bump it to medium, if we'd like to speed it up. There are much lower hanging fruit in the main pipeline for cost/performance.

jennifer-shehane · 2025-09-17T14:43:29Z

.husky/pre-commit

+    echo "❌ Warning: CircleCI CLI not found! Install the CircleCi CLI to edit the CircleCI configuration."
+    exit 1
+  fi


Verified this works

Also fails if errors packing after install

jennifer-shehane · 2025-09-17T14:48:36Z

.husky/pre-commit

+      echo "  🔍 Validating ${output_file}"
+      if ! circleci config validate "$output_file"; then
+        echo "    ❌ Validating ${output_file} failed"
+        exit 1
+      fi
+      echo "    ✅ ${dirname}.yml configuration validated successfully"


jennifer-shehane · 2025-09-17T15:01:27Z

@cacieprins Are these meant to run on the full run? They run on develop on the linux job, but not on this run with the 'full-workflow. (Not saying it necessarily should, just wanting to confirm what we want as the behavior here)

Also, it seems this branch is running both a linux-x64 workflow and a pull-request workflow, which is duplicating every running test.

…branch

…anch

…branch

…anch

…branch

…anch

jennifer-shehane

Perhaps revisit something to check in CI if someone skips the precommit hooks

AtofStryker · 2025-09-17T21:13:40Z

.husky/pre-commit

+    echo "❌ Warning: CircleCI CLI not found! Install the CircleCi CLI to edit the CircleCI configuration."
+    exit 1
+  fi


Also fails if errors packing after install

cacieprins added 7 commits September 9, 2025 13:54

add husky script to build circleci yml files

e66e778

add circleci cli as a required tool for working with .circleci

bf75cda

break the original workflows.yml file into separate pieces, using cir…

b1aeba4

…cleci config pack to compose them into the main workflows.yml file

fix pull request workflow def

d7dd504

more robust precommit for circleci packing

2caafba

even nicer stdout for precommit :)

7e4285f

allow pr pipeline on this branch

bdb8194

cacieprins marked this pull request as draft September 10, 2025 19:43

cacieprins added 2 commits September 11, 2025 10:23

split up the config.yml to demonstrate more fully

79c4d96

Merge branch 'develop' into use-pack-for-circle

36895e0

cacieprins marked this pull request as ready for review September 12, 2025 15:29

Merge branch 'develop' into use-pack-for-circle

c5c623c

cacieprins added 2 commits September 12, 2025 16:05

fix conditional on pr pipeline

84d0529

Merge branch 'develop' into use-pack-for-circle

fa96551

jennifer-shehane assigned cacieprins Sep 15, 2025

jennifer-shehane self-requested a review September 15, 2025 15:10

Merge branch 'develop' into use-pack-for-circle

2cd55e7

cacieprins commented Sep 16, 2025

View reviewed changes

.husky/pre-commit Outdated Show resolved Hide resolved

cacieprins commented Sep 16, 2025

View reviewed changes

cacieprins requested review from mschile, AtofStryker and ryanthemanuel September 16, 2025 15:39

cacieprins added 4 commits September 16, 2025 11:40

exit 1 if circleci cli not found and circleci config files staged for…

826aa6b

… commit

use linux-x64 executor for unit-tests

51d6d0a

try using ipv6 in contributor with correct executor

59c2f2b

ensure node

5d9a7b1

AtofStryker requested changes Sep 16, 2025

View reviewed changes

update github action to update browser versions to point to the corre…

5fb5125

…ct file

cacieprins added 3 commits September 16, 2025 12:49

ensure node more times

2d2d92d

fix export

95ebbd1

reduce expected result count

4ac065b

jennifer-shehane requested changes Sep 17, 2025

View reviewed changes

jennifer-shehane reviewed Sep 17, 2025

View reviewed changes

cacieprins added 2 commits September 17, 2025 10:20

Merge branch 'develop' into use-pack-for-circle

897da0d

run full workflow menu on this branch

a9bcbe8

cacieprins requested a review from AtofStryker September 17, 2025 14:26

bump config class to medium

37ad3e6

jennifer-shehane reviewed Sep 17, 2025

View reviewed changes

cypress-bot[bot] added 9 commits September 17, 2025 15:10

index on use-pack-for-circle: a9bcbe8 run full workflow menu on this …

666e6b0

…branch

WIP on use-pack-for-circle: a9bcbe8 run full workflow menu on this br…

560635a

…anch

Merge commit 'stash' into use-pack-for-circle

cd5812b

index on use-pack-for-circle: a9bcbe8 run full workflow menu on this …

820ccc6

…branch

WIP on use-pack-for-circle: a9bcbe8 run full workflow menu on this br…

883842e

…anch

Merge commit 'stash' into use-pack-for-circle

a091241

index on use-pack-for-circle: a9bcbe8 run full workflow menu on this …

74f176d

…branch

WIP on use-pack-for-circle: a9bcbe8 run full workflow menu on this br…

9050e7c

…anch

Merge commit 'stash' into use-pack-for-circle

eab6571

jennifer-shehane self-requested a review September 17, 2025 15:32

jennifer-shehane approved these changes Sep 17, 2025

View reviewed changes

AtofStryker approved these changes Sep 17, 2025

View reviewed changes

		@@ -0,0 +1,2844 @@
		version: 2.1

		chrome-stable-version: &chrome-stable-version "140.0.7339.127"

chore: use circleci cli to package ci configurations #32462

Are you sure you want to change the base?

chore: use circleci cli to package ci configurations #32462

Uh oh!

Conversation

cacieprins commented Sep 10, 2025

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Uh oh!

cypress bot commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AtofStryker Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jennifer-shehane left a comment

Choose a reason for hiding this comment

Uh oh!

jennifer-shehane left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jennifer-shehane commented Sep 17, 2025

Uh oh!

jennifer-shehane left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cypress bot commented Sep 12, 2025 •

edited

Loading

AtofStryker Sep 16, 2025 •

edited

Loading