Skip to content

docs: refresh included readme #1070

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

Merged

Conversation

MikeMcC399
Copy link
Collaborator

Issues

The document included/README is outdated. It is at a Cypress legacy level using Cypress 9.4.1 (pre Cypress 10.x).

  1. Examples use legacy Cypress Docker image cypress/included:9.4.1. They will only run against a legacy Cypress project (Cypress < 10.x).
  2. The linked blog How to Run Cypress in Docker With a Single Command from May 2, 2019 is based on outdated and legacy information.
  3. The linked blog End-to-End Testing Web Apps: The Painless Way contains the text "Update (2022-10-25): I no longer recommend Cypress for end-to-end testing web applications. For new projects, I recommend using Playwright instead.". It is also based on describing a legacy Cypress environment.

Changes

  1. Update Cypress Docker image to a non-legacy current version cypress/included:13.10.0 in each of the examples.
  2. Update other parameters for non-legacy use.
  3. Remove the link to the outdated blog post How to Run Cypress in Docker With a Single Command.
  4. Remove the link to the outdated blog post End-to-End Testing Web Apps: The Painless Way

@cypress-app-bot
Copy link

@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review May 28, 2024 12:35
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice refresh

@jennifer-shehane jennifer-shehane merged commit 52357f0 into cypress-io:master May 29, 2024
33 checks passed
@MikeMcC399
Copy link
Collaborator Author

@jennifer-shehane

Nice refresh

Thanks! I will follow up with some more updates to get everything onto non-legacy examples.

@MikeMcC399 MikeMcC399 deleted the refresh/included-readme branch May 29, 2024 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants