@testream/cypress-reporter 1.2.3 → 1.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -8
- package/package.json +14 -6
package/README.md
CHANGED
|
@@ -1,18 +1,47 @@
|
|
|
1
|
-
# @testream/cypress-reporter
|
|
1
|
+
# @testream/cypress-reporter: Cypress test reporting for Jira
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@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.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## What the reporter sends to Testream and Jira
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- Cypress end-to-end and component test results
|
|
8
|
+
- Failure messages, stack traces, screenshots, and videos
|
|
9
|
+
- Bounded source evidence when a test file and test name can be matched
|
|
10
|
+
- Branch, commit, build, environment, and CI context
|
|
11
|
+
- Suite changes and trends for Jira work and release reviews
|
|
12
|
+
|
|
13
|
+
The result is a shared quality record that connects Cypress execution to the delivery work teams already manage in Jira.
|
|
14
|
+
|
|
15
|
+
## Install and configure
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install --save-dev @testream/cypress-reporter
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Run Cypress and publish its results with:
|
|
8
22
|
|
|
9
23
|
```bash
|
|
10
24
|
npx @testream/cypress-reporter -k $TESTREAM_API_KEY
|
|
11
25
|
```
|
|
12
26
|
|
|
13
|
-
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
## Cypress evidence in CI/CD
|
|
30
|
+
|
|
31
|
+
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.
|
|
32
|
+
|
|
33
|
+
## Frequently asked questions
|
|
34
|
+
|
|
35
|
+
### Do we need to recreate automated tests as manual Jira cases?
|
|
36
|
+
|
|
37
|
+
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.
|
|
38
|
+
|
|
39
|
+
### Can it report both end-to-end and component tests?
|
|
40
|
+
|
|
41
|
+
Yes. The reporter publishes the Cypress results produced by the configured run, including end-to-end and component testing workflows.
|
|
14
42
|
|
|
15
|
-
|
|
16
|
-
contains a test `filePath` and the source file can be matched by test name.
|
|
43
|
+
## Official Testream resources
|
|
17
44
|
|
|
18
|
-
|
|
45
|
+
- [Cypress Jira integration](https://testream.app/cypress-jira-integration)
|
|
46
|
+
- [Complete Cypress reporter setup guide](https://docs.testream.app/reporters/cypress)
|
|
47
|
+
- [Install Testream – Automated Test Management for Jira](https://marketplace.atlassian.com/3048460704)
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@testream/cypress-reporter",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "Cypress
|
|
3
|
+
"version": "1.2.4",
|
|
4
|
+
"description": "Publish Cypress end-to-end and component test results, screenshots, videos, and CI metadata to Testream and Jira.",
|
|
5
|
+
"homepage": "https://testream.app/cypress-jira-integration",
|
|
5
6
|
"main": "dist/index.js",
|
|
6
7
|
"types": "dist/index.d.ts",
|
|
7
8
|
"scripts": {
|
|
@@ -21,11 +22,18 @@
|
|
|
21
22
|
"url": "git+https://github.com/testream/docs.git"
|
|
22
23
|
},
|
|
23
24
|
"keywords": [
|
|
24
|
-
"
|
|
25
|
-
"test-management",
|
|
26
|
-
"jira",
|
|
25
|
+
"testream",
|
|
27
26
|
"cypress",
|
|
28
|
-
"
|
|
27
|
+
"cypress-reporter",
|
|
28
|
+
"cypress-jira",
|
|
29
|
+
"jira",
|
|
30
|
+
"test-management",
|
|
31
|
+
"automated-test-management",
|
|
32
|
+
"test-reporting",
|
|
33
|
+
"ci-cd",
|
|
34
|
+
"ctrf",
|
|
35
|
+
"e2e",
|
|
36
|
+
"component-testing"
|
|
29
37
|
],
|
|
30
38
|
"author": "Testream",
|
|
31
39
|
"license": "SEE LICENSE IN LICENSE",
|