Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scripts to update examples to cypress@latest #779

Merged
merged 8 commits into from
Mar 2, 2023

Conversation

MikeMcC399
Copy link
Collaborator

This PR implements the suggestion from #767 "Automated examples update to latest Cypress version" by providing a new npm script command:

npm run update:cypress

to update Cypress examples to the latest version of Cypress. (The v9 examples are untouched and left at version 9.7.0.)

The process is documented in docs/MAINTENANCE.md.

  1. update-cypress-latest.sh is the main script
  2. update-cypress-latest-npm.sh updates examples using npm
  3. update-cypress-latest-other.sh updates examples using yarn and pnpm

The npm run check:markdown script is extended to check also the new docs/ directory.

The previous script scripts/npm-install-examples.sh is replaced.

@MikeMcC399
Copy link
Collaborator Author

MikeMcC399 commented Feb 6, 2023

Tested locally on Ubuntu 22.04 and Windows 11 Pro.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review February 10, 2023 11:38
@MikeMcC399 MikeMcC399 force-pushed the build/update-cypress-latest branch 4 times, most recently from 4807934 to fba8e1e Compare February 14, 2023 13:00
@MikeMcC399
Copy link
Collaborator Author

MikeMcC399 commented Feb 15, 2023

@jaffrepaul

I successfully ran this to update to Cypress 12.5.1, so from my point of view this PR is ready to merge.

It's also non-critical in the sense that it is purely a maintenance tool. It is not called by the action itself or by the examples.

I haven't submitted a PR with the actual update to Cypress 12.5.1 waiting in branch update/examples-to-12-5-1. Perhaps 12.6. is around the corner and it would be better to wait? Cypress 12.6.0 has been released, so I did that instead (PR #795).

@CLAassistant
Copy link

CLAassistant commented Feb 25, 2023

CLA assistant check
All committers have signed the CLA.

@MikeMcC399 MikeMcC399 marked this pull request as draft February 25, 2023 11:10
Add MAINTENANCE document to new docs/ directory
Extend markdown link check to docs/
@MikeMcC399
Copy link
Collaborator Author

This is now modified to save exact versions of Cypress i.e. 12.7.0 not ^12.7.0 also if the scripts are run directly, for instance
./scripts/update-cypress-latest-npm.sh instead of being run using npm run cypress:update.

In the latter case they already took the setting save-exact=true from .npmrc.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review February 27, 2023 17:43
@mjhenkes mjhenkes self-assigned this Mar 2, 2023
docs/MAINTENANCE.md Outdated Show resolved Hide resolved
Co-authored-by: Bill Glesias <bglesias@gmail.com>
@mjhenkes mjhenkes merged commit 4160b9d into cypress-io:master Mar 2, 2023
@MikeMcC399 MikeMcC399 deleted the build/update-cypress-latest branch March 2, 2023 15:15
@github-actions
Copy link

github-actions bot commented Mar 7, 2023

🎉 This PR is included in version 5.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants