@testream/cypress-reporter: Cypress test reporting for Jira

@testream/cypress-reporter runs Cypress and publishes end-to-end or component test results to Testream as durable, Jira-visible evidence. Cypress remains the execution source, so teams do not have to recreate every automated test as a manual Jira case.

What the reporter sends to Testream and Jira

• Cypress end-to-end and component test results
• Failure messages, stack traces, screenshots, and videos
• Bounded source evidence when a test file and test name can be matched
• Branch, commit, build, environment, and CI metadata, including merge-base data for pull-request comparisons
• Suite changes and trends for Jira work and release reviews

For pull requests, the reporter uses an explicit TESTREAM_MERGE_BASE_SHA or provider-supplied merge-base metadata; otherwise it resolves git merge-base from the existing checkout without fetching. Keep history available (fetch-depth: 0 on GitHub Actions); if no merge base can be resolved, Testream falls back to execution-time comparison.

The result is a shared quality record that connects Cypress execution to the delivery work teams already manage in Jira.

Install and configure

npm install --save-dev @testream/cypress-reporter

Run Cypress and publish its results with:

npx @testream/cypress-reporter -k $TESTREAM_API_KEY

Store TESTREAM_API_KEY as a protected CI secret. Generated CTRF reports are enriched with bounded source snippets when the report contains a test filePath and the source file can be matched by test name.

Cypress evidence in CI/CD

Use the command in the CI job that already runs Cypress. The reporter collects the completed run, publishes its structured results and available artifacts, and makes that evidence available through Testream and Jira. It works with command-based providers such as GitHub Actions, GitLab CI/CD, Azure Pipelines, Jenkins, and Bitbucket Pipelines.

Frequently asked questions

Do we need to recreate automated tests as manual Jira cases?

No. Testream preserves your code-first Cypress suite as the execution source. It adds Jira visibility and history without asking the team to maintain a second manual representation of each automated test.

Can it report both end-to-end and component tests?

Yes. The reporter publishes the Cypress results produced by the configured run, including end-to-end and component testing workflows.

Official Testream resources

• Cypress Jira integration
• Complete Cypress reporter setup guide
• Install Testream – Automated Test Management for Jira