chore: Add a CircleCI parameter for target publish-binary branch #32665
Conversation
…ed value for branch - migrates trigger-publish-binary-pipeline.js to an inlined bash script to speed it up and simplify it - adds a pipeline parameter that can be set via CircleCI UI to determine which branch we use in the publish-binary pipeline, to reduce file churn and human error - updates the packages/electron/README.md to include the simplified steps
| - [ ] Temporarily update the circle configuration to allow `cypress` to run against the branch | ||
| - [ ] Temporarily set target `cypress-publish-binary` branch as a `branch` property on the request body in [../../scripts/binary/trigger-publish-binary-pipeline.js](../../scripts/binary/trigger-publish-binary-pipeline.js) script, so that you can test against this branch from the electron upgrade branch. This property must be set both at the root of the body object, and on the `parameters` key. If it is not set at the root, the binary pipeline will continue to use the primary branch. | ||
| - [ ] Add your branch name to the `&full-workflow-filters` anchor in [`@pipeline.yml`](../../.circleci/src/pipeline/@pipeline.yml) |
There was a problem hiding this comment.
this can be parameterized as well (separately, to reduce delta surface)
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
ci/parameterize-binary-branch
|
| Run status |
|
| Run duration | 19m 17s |
| Commit |
|
| Committer | Cacie Prins |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
14
|
Pending
|
1098
|
Skipped
|
4
|
Passing
|
26522
|
| View all changes introduced in this branch ↗︎ | |
Warning
Partial Report: The results for the Application Quality reports may be incomplete.
UI Coverage
45.61%
|
|
|---|---|
|
Untested elements
|
187
|
|
Tested elements
|
161
|
Accessibility
97.98%
|
|
|---|---|
|
Failed rules
|
4 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
101
|
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
cacieprins
force-pushed
the
ci/parameterize-binary-branch
branch
from
57afea5 to
5d50a15
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
@cacieprins Is it possible to have the trigger-publish-binary-pipeline workflow run on this PR to test it working?
| if [[ $? != 0 ]]; then | ||
| echo "Failed to compose the request body. Skipping pipeline trigger." | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
Bug: Bug
The JSON body for the pipeline trigger directly interpolates environment variables like $CIRCLE_BRANCH without proper JSON escaping. If these variables contain special characters, the JSON becomes malformed, causing the API request to fail.
Additional details
This should reduce cognitive load regarding branches when performing Electron upgrades.
Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?Note
Adds a CircleCI parameter to select the cypress-publish-binary branch and replaces the Node trigger script with an inline bash command, updating docs accordingly.
publish-binary-branchin.circleci/config.ymland@pipeline.yml.commands/trigger-publish-binary-pipeline.yml(bash), persistingtriggered_pipeline.json.create-and-trigger-packaging-artifactsjob, passing<< pipeline.parameters.publish-binary-branch >>.scripts/binary/trigger-publish-binary-pipeline.js.packages/electron/README.mdElectron upgrade steps to include adding branch to&full-workflow-filtersand settingpublish-binary-branchin CircleCI UI.Written by Cursor Bugbot for commit 2b684c4. This will update automatically on new commits. Configure here.