Skip to content

Provide working docker-dev instructions #30104

@MikeMcC399

Description

@MikeMcC399

What would you like?

The documentation section CONTRIBUTING > Docker as a performance constrained environment should provide instructions which work.

Why is this needed?

In the section CONTRIBUTING > Docker as a performance constrained environment:

  1. The docker compose run option --service-port is incorrect and provokes the error message unknown flag: --service-port. The correct option is --service-ports. This is already correctly and indirectly implemented through the script docker-dev (which invokes "./scripts/run-docker-local.sh dev").

  2. The use of the Cypress Docker container cypress/browsers:latest by the dev service in docker-compose.yml is not fully compatible with the instructions to build Cypress with yarn install.

    • As mentioned in CONTRIBUTING > Requirements > Debian/Ubuntu, g++ and make are needed to build Cypress without errors.
    • Cypress should be built using the version of Node.js in .node-version, which is currently 18.17.1 22.15.1. cypress/browsers:latest however currently runs under Node.js 20.17.0 22.18.0 LTS, which is the wrong version.

Other

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    process: contributingRelated to contributing to the Cypress codebasetype: choreWork is required w/ no deliverable to end user

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions