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

docs: remove second "Docker image" non-example section #845

Merged
merged 2 commits into from
Mar 23, 2023

Conversation

MikeMcC399
Copy link
Collaborator

This PR removes the second section Docker image for the following reasons:

  • It does not explain how to use the GitHub action. On the contrary it explains how not to use it.
  • It is confusing, because there is another section higher up in the README file with exactly the same header Docker image which does explain how to use the GH Action with a Docker container.
  • With the addition of documentation for pnpm in PR docs: add pnpm example #844 it would need to be explained for completeness how this could also be a solution for using a Docker image also without a pnpm-lock.yaml file.

Here is the text to be removed:

Docker image

If your repository does not have package.json or yarn.json (maybe it contains a static site and does not need any dependencies), you can run Cypress tests using cypress/included:... Cypress Docker images. In that case you don't even need this GH Action, instead use the Docker container and write cypress run command like this example from cypress-gh-action-included (legacy)

name: included
on: push
jobs:
  cypress-run:
    runs-on: ubuntu-22.04
    # Docker image with Cypress pre-installed
    # https://github.com/cypress-io/cypress-docker-images/tree/master/included
    container: cypress/included:3.8.3
    steps:
      - uses: actions/checkout@v3
      - run: cypress run

@MikeMcC399 MikeMcC399 marked this pull request as ready for review March 21, 2023 16:59
@nagash77 nagash77 requested a review from mjhenkes March 22, 2023 15:11
@AtofStryker AtofStryker merged commit bc6d81b into cypress-io:master Mar 23, 2023
@AtofStryker AtofStryker removed their assignment Mar 23, 2023
@MikeMcC399 MikeMcC399 deleted the docs/docker-non-example branch March 23, 2023 15:20
@github-actions
Copy link

🎉 This PR is included in version 5.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@MikeMcC399 MikeMcC399 added the documentation Improvements or additions to documentation label Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants