Skip to content

docs: update README integration test instructions#10916

Open
paulwellnerbou wants to merge 1 commit into
swagger-api:masterfrom
paulwellnerbou:docs/10915-readme-e2e-instructions
Open

docs: update README integration test instructions#10916
paulwellnerbou wants to merge 1 commit into
swagger-api:masterfrom
paulwellnerbou:docs/10915-readme-e2e-instructions

Conversation

@paulwellnerbou

@paulwellnerbou paulwellnerbou commented Jun 8, 2026

Copy link
Copy Markdown

Description

Updates the README "Integration Tests" section, which was outdated:

  • Removed reference to the no-longer-existing npm run e2e script.
  • Removed the old Nightwatch/Selenium (JDK 7+) instructions, since the project migrated to Cypress.
  • Documented the current Cypress-based commands:
    • npm run cy:ci — full headless suite (starts servers, runs Cypress, tears them down); matches CI.
    • npm run cy:dev — interactive Cypress runner.
    • Running a single spec headless via npm run cy:start + npm run cy:run -- --spec "<path>".

Motivation and Context

New contributors following the README couldn't run the e2e suite locally because the documented command no longer exists. Fixes #10915.

How Has This Been Tested?

Documentation-only change. Verified the documented commands locally (cy:ci, and the single-spec invocation through cy:run -- --spec).

Screenshots (if appropriate):

N/A

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • ❌ Dependency changes (any modification to dependencies in package.json)
  • ❌ Bug fixes (non-breaking change which fixes an issue)
  • ❌ Improvements (misc. changes to existing features)
  • ❌ Features (non-breaking change which adds functionality)

My changes...

  • ❌ are breaking changes to a public API (config options, System API, major UI change, etc).
  • ❌ are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • ❌ are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • ❌ My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • ❌ My changes can and should be tested by unit and/or integration tests.
  • ❌ If yes to above: I have added tests to cover my changes.
  • ❌ If yes to above: I have taken care to cover edge cases in my tests.
  • ❌ All new and existing tests passed.

Replace the removed `npm run e2e` script and outdated Nightwatch/Selenium
(JDK 7+) references with the current Cypress-based commands: `cy:ci` for
the full headless suite, `cy:dev` for the interactive runner, and how to
run a single spec.

Fixes swagger-api#10915
@paulwellnerbou paulwellnerbou force-pushed the docs/10915-readme-e2e-instructions branch from 19d1224 to 9261c32 Compare June 8, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant