test: remove example-install-only - #1838
Open
MikeMcC399 wants to merge 2 commits into
Open
Conversation
Collaborator
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Situation
The workflow example-install-only.yml pins a version of Cypress separately from the version defined in examples/install-only.
Renovate is unable to maintain the separate version in the workflow, resulting in manual instructions being written for
Code scanning typically flags pinning npm versions in workflows like this, since current updating utilities such as Renovate and Dependabot can't maintain them.
The workflow currently runs on ubuntu-24.04 using the default Node.js 22.23.1 version.
If it is upgraded to Node.js 24.x, it warns. And if it is upgraded to npm 12, it fails.
Attempting to make it compatible with npm 12, exposes other errors in the workflow, such as the npm install running in the wrong directory.
Assessment
Given heightened awareness of supply-chain vulnerabilities, it can no longer be considered as a good example and it is not fixable. npm does not allow picking only one dependency defined in
package.json, although it can choose betweendevandprod. Renovate can't keep it synced either.The higher frequency of reported vulnerabilities in the npm ecosystem, compared to earlier, means that it is no longer viable to be manually updating dependencies. The main part of the work needs to be automated, and in this repo that means relying on Renovate.
Change
Remove the following, and all references to this example set:
Verification
Under Ubuntu 24.04.4 LTS, Node.js 24.18.0 LTS execute:
Confirm that the script runs without error and no longer prompts to manually update example-install-only.yml.
Note
Low Risk
Documentation and example-only removals with no changes to the published GitHub Action runtime behavior.
Overview
Removes the install Cypress only CI pattern from the repo because it pinned Cypress separately from
package.json, could not be kept in sync by Renovate, and was fragile on newer Node/npm.The PR deletes
.github/workflows/example-install-only.ymland the wholeexamples/install-onlyproject (config, spec, lockfile, README). README drops the TOC link and the "Install Cypress only" section with its sample workflow. docs/MAINTENANCE.md no longer mentions hand-editing the workflow when bumping Cypress. scripts/update-cypress-latest-npm.sh stops updating that example, and scripts/update-cypress-latest.sh no longer prints instructions to manually edit the workflow or open it in VS Code.Reviewed by Cursor Bugbot for commit 668819e. Bugbot is set up for automated code reviews on this repo. Configure here.