cypress-io / cypress-docker-images

Docker images with Cypress dependencies and browsers
https://on.cypress.io/continuous-integration
MIT License
1.01k stars 376 forks source link

Review: examples/included-with-plugins #1087

Open MikeMcC399 opened 1 month ago

MikeMcC399 commented 1 month ago

Situation

The included/README > Using plugins section refers to a legacy example, based on the cypress/included:3.8.0 Docker image and running Cypress tests using the @cypress/skip-test plugin.

The @cypress/skip-test plugin is obsolete and the repository https://github.com/cypress-io/cypress-skip-test was archived on Jan 31, 2023.

Alternatives

The example is very focussed on the obsolete @cypress/skip-test plugin and replacements would not show plugin usage.

Suggestion

There is nothing special about plugins compared to any other dependencies. I suggest replacing the obsolete plugin example with one using a repo with a full set of dependencies, such as https://github.com/cypress-io/cypress-example-kitchensink. I will make a separate proposal for this after cleaning up the remaining legacy examples.

Next step: remove the legacy obsolete example included-with-plugins and references to it.