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

chore: remove legacy examples #1088

Closed

Conversation

MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented Jun 3, 2024

This PR closes the following issues. Each detailed issue discusses the resolution alternatives and describes that each of the examples should be removed.

Issue

Examples listed in the following documentation sections are based on legacy versions of Cypress:

examples/included-as-non-root

examples/included-as-non-root shows how to build a new Docker image on top of cypress/included image and run the tests as non-root user node.

This example is obsolete because the issue it resolved in Cypress 3.8.0 is already resolved as standard in current Cypress Docker images.

examples/included-as-non-root-alternative

examples/included-as-non-root-alternative shows another approach to allow built-in non-root user node to run tests using cypress/included image.

This example is obsolete because the setup it uses to resolve the issue with non-root users is already included as standard in current Cypress Docker images.

examples/included-as-non-root-mapped

examples/included-as-non-root-mapped shows how to build a Docker image on top of cypress/included that runs with a non-root user that matches the id of the user on the host machine. This way, the permissions on any files created during the test run match the user's permissions on the host machine.

The example is based on the legacy Cypress version 5.6.0. When updated to a current Cypress version and tested on Ubuntu, it did not seem to resolve any permissions issues caused by using Docker bind mounts. Cypress users should refer to the operating system and environment specific Docker documentation for configuration options.

examples/included-with-plugins

examples/included-with-plugins shows how to use locally installed Cypress plugins while running cypress/included image.

The example is specific to the @cypress/skip-test plugin, which is obsolete because the functionality is now available in standard Cypress versions.

@cypress-app-bot
Copy link

@MikeMcC399 MikeMcC399 self-assigned this Jun 3, 2024
@MikeMcC399 MikeMcC399 marked this pull request as ready for review June 3, 2024 07:30
@MikeMcC399 MikeMcC399 marked this pull request as draft June 3, 2024 10:01
@MikeMcC399 MikeMcC399 removed the request for review from jennifer-shehane June 3, 2024 10:19
@MikeMcC399
Copy link
Collaborator Author

This PR needs some more work so that there is some information left about running under a non-root user.

@MikeMcC399 MikeMcC399 force-pushed the remove/legacy-examples branch 2 times, most recently from 0d98576 to b7f941c Compare June 5, 2024 15:48
@MikeMcC399
Copy link
Collaborator Author

I'm going to suggest handling each of these legacy examples individually. They contain some useful information and it would be better to try and preserve what is still helpful.

@MikeMcC399 MikeMcC399 closed this Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants