Cypress Integration with CI Insights

This guide shows how to configure Cypress to produce JUnit reports and upload them to CI Insights within a GitHub Actions workflow.

By default, Cypress doesn’t generate JUnit-format test results. You need to enable it in your cypress.config.ts file.

This is documenteded on Cypress website.

The best way to do this is to leverage cypress-multi-reporters so you can both have JUnit generated while keeping the standard output.

1. Add cypress-multi-reporters to your package file, e.g., npm install --save-dev cypress-multi-reporters mocha-junit-reporter.

2. Create a reporter-config.json at the top of your repository with this configuration:

   {
     "reporterEnabled": "spec, mocha-junit-reporter",
     "mochaJunitReporterReporterOptions": {
       "mochaFile": "cypress/results/junit-[hash].xml"
     }
   }

Once you have the JUnit file produced by Cypress, add a step to upload these results to CI Insights via the mergifyio/gha-mergify-ci action.

In the workflow file where Cypress is launched, after running npm run test:cypress (or similar), include a step like:

- name: Mergify CI Upload
  if: success() || failure()
  uses: mergifyio/gha-mergify-ci@v8
  with:
    token: ${{ secrets.MERGIFY_TOKEN }}
    report_path: cypress/results/junit*.xml

Key Points:

• if: success() || failure(): Runs the upload step even if tests fail, ensuring CI Insights has the full report.
• report_path: cypress/results/junit*.xml: Points to where your JUnit file is located. Make sure it matches the path you set in your CI job.

If you use a job matrix in your workflow (e.g., to test across multiple versions), ensure you set the job_name input (or MERGIFY_JOB_NAME environment variable) so CI Insights can properly distinguish reports for each matrix job.

For example, with:

jobs:
  example_matrix:
    strategy:
      matrix:
        version: [10, 12, 14]

Your upload step should look like:

- name: Mergify CI Upload
  if: success() || failure()
  uses: mergifyio/gha-mergify-ci@v8
  with:
    job_name: example_matrix (${{ matrix.version }})
    token: ${{ secrets.MERGIFY_TOKEN }}
    report_path: cypress/results/junit*.xml

In order to benefit from CI Insights Quarantine, you need to add continue-on-error: true in your GitHb Actions step that execute your tests and generates the JUnit file. The step running the gha-mergify-ci action will determine the success or failure conclusion, considering quarantined tests.

After pushing these changes:

1. Your GitHub Actions workflow will run tests with Cypress.
2. Cypress generates JUnit files.
3. The Mergify CI action uploads that file to CI Insights.

You can then see your test results, including failures and flaky tests, directly in the CI Insights dashboard.

• The CLI provides information about the upload. Check the logs in GitHub Actions.
• File Paths: Double-check that the output file matches the path used in report_path.
• Permissions: Make sure the MERGIFY_TOKEN is valid and setup in your GitHub Actions secrets as explained in the docs.
• Workflow Conditions: If your step is not running, confirm the if condition is actually triggered in your job.