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: rework docker example #992

Merged
merged 2 commits into from
Aug 15, 2023
Merged

Conversation

MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented Aug 15, 2023

This PR improves the README > Docker image example:

  1. It builds on the suggestions made in the open PRs docs: adding in information on running firefox in a container in the README #938 and Update README.md to include user option #963 to add options: --user 1001 to the Docker example. For GitHub-hosted runners --user 1001 is mandatory when testing against Mozilla Firefox and optional for other browsers.

  2. The container is changed to the generic cypress/browsers:latest image tag to provide a timeless and easily readable example. A link to the Docker Hub cypress/browsers:latest is provided so that readers can search for specific versions such as cypress/browsers:node-20.5.0-chrome-114.0.5735.133-1-ff-114.0.2-edge-114.0.1823.51-1

  3. The example is linked to the cypress-io/cypress-docker-images repo for further information. A pointer to cypress-io/cypress-docker-images > factory is given for users who want to generate containers for specific versions.

Verification

The Workflow below demonstrates the example using the four supported browsers chrome, edge, electron & firefox on a GitHub-hosted runner, with successful results logged to run 5866097433.

name: example-docker

on: workflow_dispatch

jobs:
  docker-browsers:
    runs-on: ubuntu-22.04
    strategy:
      fail-fast: false
      matrix:
        browser: [chrome, edge, electron, firefox]
    # from https://hub.docker.com/r/cypress/browsers/tags
    container:
      image: cypress/browsers:latest
      options: --user 1001
    steps:
      - uses: actions/checkout@v3
      - uses: cypress-io/github-action@v5
        with:
          working-directory: examples/basic
          browser: ${{ matrix.browser }}

@cypress-app-bot
Copy link

@MikeMcC399

This comment was marked as outdated.

README.md Show resolved Hide resolved
@nagash77 nagash77 merged commit 05a8962 into cypress-io:master Aug 15, 2023
112 checks passed
@MikeMcC399 MikeMcC399 deleted the docker-example branch August 15, 2023 18:38
@github-actions
Copy link

🎉 This PR is included in version 5.8.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@MikeMcC399 MikeMcC399 added the documentation Improvements or additions to documentation label Jan 22, 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