This repository is a practical Cypress + Jira integration example using @testream/cypress-reporter. It shows how to upload Cypress E2E results and failure screenshots from local runs and GitHub Actions into Jira through Testream.

If you are searching for "Cypress Jira reporter", "Cypress GitHub Actions Jira integration", or "send Cypress test results to Jira", this repo is the implementation template.

• CI-ready: Includes a working GitHub Actions workflow with cypress-io/github-action.
• Failure artifacts in Jira: Captures screenshots on failed tests and uploads them.
• Safe onboarding: Upload is enabled only when TESTREAM_API_KEY exists.
• Real debugging flow: Intentional failing tests show how triage looks in Testream/Jira.

Testream is an automated test management and reporting platform for Jira teams. It ingests test results from frameworks like Cypress, Playwright, Jest, and Vitest, then provides failure analysis, trends, and release visibility inside Jira.

If this sample repository is not the framework you need, browse all native reporters in the Testream docs: https://docs.testream.app/.

Click to see how Testream turns raw CI test results into actionable Jira insights (failures, trends, and release visibility):

Install the Testream Automated Test Management and Reporting for Jira app in your Jira workspace to view uploaded runs.

cypress/
  e2e/
    navigation.cy.ts   - Navigation tests (passing + 1 intentional failure)
    actions.cy.ts      - Form interaction tests (passing + 1 intentional failure)
    assertions.cy.ts   - DOM assertion tests (passing + 1 intentional failure)
  support/
    commands.ts        - Custom Cypress commands
    e2e.ts             - Support entry point
cypress.config.ts
.github/workflows/cypress.yml
.env.example

The intentional failures exist so you can verify how errors and screenshots appear in Jira.

1. Sign in at testream.app.
2. Create a project.
3. Copy your API key.

npm install

Requires Node.js 18+.

cp .env.example .env

Set at least:

TESTREAM_API_KEY=<your key>

npm test

When TESTREAM_API_KEY is present, results upload automatically. Without it, tests still run locally and no upload happens.

The Testream reporter is initialized inside setupNodeEvents. Key behavior:

• uploadEnabled is derived from API key presence.
• Reporter is only created when a key exists.
• screenshotOnRunFailure: true and reporter screenshot: true attach failure screenshots.
• failOnUploadError is currently false in this example (non-blocking upload behavior).
• CI metadata (commitSha, repositoryUrl, branchName, buildNumber, buildUrl) is auto-detected.

Reporter docs: https://docs.testream.app/reporters/cypress

The workflow at .github/workflows/cypress.yml runs on push, pull request, and manual dispatch.

Add this repository secret:

Settings -> Secrets and variables -> Actions -> New repository secret

Workflow env examples already wired:

After connecting your Testream project to Jira, you get:

• Dashboard views for pass/fail health
• Failed test details with stack traces and screenshots
• Trend analytics across runs
• Jira issue creation from failures with context included

• Ensure TESTREAM_API_KEY is set in .env.
• Restart your terminal session if env values were changed.

• Confirm TESTREAM_API_KEY exists in repository secrets.
• For fork PRs, check whether secrets are available to the workflow.

• Keep screenshotOnRunFailure: true in Cypress config.
• Keep reporter option screenshot: true enabled.

It is an example designed to be copied and adapted. The CI and reporter wiring are production-oriented.

They demonstrate real failure triage in Jira, including screenshot artifacts.

Yes. The test suite runs normally without TESTREAM_API_KEY; upload is skipped.

• Testream app: https://testream.app
• Testream Automated Test Management and Reporting for Jira: https://marketplace.atlassian.com/apps/3048460704/testream-automated-test-management-and-reporting-for-jira
• Cypress reporter docs: https://docs.testream.app/reporters/cypress
• Cypress docs: https://docs.cypress.io