Integrating Cypress tests into CI

This document describes how Cypress tests integrated into a continuous integration (CI) pipeline.

1. Cypress tests maintained as part of the project code.
2. Verifying the code quality of your Cypress tests.

Cypress tests as part of the project code

Cypress tests are part of the project repository. The CI pipeline runs the tests - you do not need to clone a separate Cypress tests repository. You install and run Cypress tests directly from the project repository. It is possible to find configuration in the file .github/workflows/ci.yml

    cypress-e2e:
        needs: [js-validation, validation, cypress-quality-gate]
        name: "Cypress-boilerplate / E2E"

Verifying Cypress test code quality

In addition to running Cypress tests, verify the code quality of your Cypress tests using ESLint and Prettier. This job is optional, and you can include it based on your project’s needs. Find the example in the same .github/workflows/ci.yml file.

    cypress-quality-gate:
        name: "Cypress-boilerplate / Lint & Format"

Following these CI configurations lets you use integrated Cypress tests in your CI pipeline, while maintaining a high standard of code quality for your test code.