Skip to content

docs: README references removed npm run e2e script for integration tests #10915

Description

@paulwellnerbou

Describe the problem

The README's "Integration Tests" section tells contributors to run integration tests with npm run e2e, but that script no longer exists in package.json. The section also still references the old Nightwatch/Selenium setup (JDK 7+ requirement), whereas the project has since migrated to Cypress.

This is confusing for new contributors trying to run the e2e suite locally.

Current README text

You will need JDK of version 7 or higher as instructed here https://nightwatchjs.org/...

Integration tests can be run locally with npm run e2e - be sure you aren't running a dev server when testing!

Expected

The docs should reflect the current Cypress-based scripts:

  • npm run cy:ci — runs the full suite headless (starts servers, runs Cypress, tears them down); this is what CI uses
  • npm run cy:dev — opens the interactive Cypress runner
  • Running a single spec headless: npm run cy:start in one terminal, then npm run cy:run -- --spec "<path>" in another (reusing the cy:run script ensures the required BROWSERSLIST_ENV=browser-production is set; a raw npx cypress run fails without it)

The JDK/Nightwatch reference can be removed entirely.

Additional context

Happy to submit a PR for this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions