@testream/jest-reporter 1.2.1 → 1.2.2
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 +32 -8
- package/package.json +14 -8
package/README.md
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
|
-
# @testream/jest-reporter
|
|
1
|
+
# @testream/jest-reporter: Jest test reporting for Jira
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@testream/jest-reporter` publishes Jest unit and integration test results from CI/CD to Testream, making failures and run context visible from Jira. Jest remains the execution source: Testream does not force teams to recreate every code-first test as a manual Jira case.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## What the reporter sends to Testream and Jira
|
|
6
|
+
|
|
7
|
+
- Passed, failed, skipped, and pending Jest results
|
|
8
|
+
- Failure messages, stack traces, source locations, and bounded snippets
|
|
9
|
+
- Branch, commit, build, environment, and CI metadata
|
|
10
|
+
- Suite changes and trends for Jira work and release reviews
|
|
11
|
+
|
|
12
|
+
This connects fast code-level feedback to the product and delivery context already followed in Jira.
|
|
13
|
+
|
|
14
|
+
## Install and configure
|
|
6
15
|
|
|
7
16
|
```bash
|
|
8
17
|
npm install --save-dev @testream/jest-reporter
|
|
@@ -25,9 +34,24 @@ module.exports = {
|
|
|
25
34
|
};
|
|
26
35
|
```
|
|
27
36
|
|
|
28
|
-
`testLocationInResults: true` is recommended because it gives the reporter exact
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
37
|
+
`testLocationInResults: true` is recommended because it gives the reporter exact line metadata. Without it, the reporter still attempts to infer source snippets from the test file, but that fallback is less reliable than Jest’s built-in location data.
|
|
38
|
+
|
|
39
|
+
## Jest evidence in CI/CD
|
|
40
|
+
|
|
41
|
+
Keep your existing Jest command and store `TESTREAM_API_KEY` as a protected secret. The reporter publishes the completed run from GitHub Actions, GitLab CI/CD, Azure Pipelines, Jenkins, or another command-based CI provider, preserving source and failure context for later inspection.
|
|
42
|
+
|
|
43
|
+
## Frequently asked questions
|
|
44
|
+
|
|
45
|
+
### Do we need to recreate automated tests as manual Jira cases?
|
|
46
|
+
|
|
47
|
+
No. Your Jest suite remains the code-first execution source. Testream adds durable reporting and Jira visibility without requiring duplicate manual cases.
|
|
48
|
+
|
|
49
|
+
### Is `testLocationInResults` required?
|
|
50
|
+
|
|
51
|
+
No, but it is strongly recommended. Exact Jest location data produces more reliable source evidence than filename and test-name inference.
|
|
52
|
+
|
|
53
|
+
## Official Testream resources
|
|
32
54
|
|
|
33
|
-
|
|
55
|
+
- [Jest Jira integration](https://testream.app/jest-jira-integration)
|
|
56
|
+
- [Complete Jest reporter setup guide](https://docs.testream.app/reporters/jest)
|
|
57
|
+
- [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/jest-reporter",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "Jest
|
|
3
|
+
"version": "1.2.2",
|
|
4
|
+
"description": "Publish Jest unit and integration test results, failures, source locations, and CI metadata to Testream and Jira.",
|
|
5
|
+
"homepage": "https://testream.app/jest-jira-integration",
|
|
5
6
|
"main": "dist/index.js",
|
|
6
7
|
"types": "dist/index.d.ts",
|
|
7
8
|
"scripts": {
|
|
@@ -20,12 +21,17 @@
|
|
|
20
21
|
"url": "git+https://github.com/testream/docs.git"
|
|
21
22
|
},
|
|
22
23
|
"keywords": [
|
|
24
|
+
"testream",
|
|
23
25
|
"jest",
|
|
24
|
-
"reporter",
|
|
25
|
-
"
|
|
26
|
+
"jest-reporter",
|
|
27
|
+
"jest-jira",
|
|
28
|
+
"jira",
|
|
26
29
|
"test-management",
|
|
27
|
-
"test-
|
|
28
|
-
"
|
|
30
|
+
"automated-test-management",
|
|
31
|
+
"test-reporting",
|
|
32
|
+
"ci-cd",
|
|
33
|
+
"ctrf",
|
|
34
|
+
"unit-testing"
|
|
29
35
|
],
|
|
30
36
|
"author": "Testream",
|
|
31
37
|
"license": "SEE LICENSE IN LICENSE",
|
|
@@ -47,13 +53,13 @@
|
|
|
47
53
|
"@jest/reporters": "^30.4.1",
|
|
48
54
|
"@jest/test-result": "^30.4.1",
|
|
49
55
|
"@jira-test-manager/shared-types": "*",
|
|
50
|
-
"@types/node": "^
|
|
56
|
+
"@types/node": "^25.9.3",
|
|
51
57
|
"@typescript-eslint/eslint-plugin": "^6.17.0",
|
|
52
58
|
"@typescript-eslint/parser": "^6.17.0",
|
|
53
59
|
"@vercel/ncc": "^0.38.1",
|
|
54
60
|
"eslint": "^8.56.0",
|
|
55
61
|
"prettier": "^3.1.1",
|
|
56
|
-
"typescript": "^
|
|
62
|
+
"typescript": "^6.0.3",
|
|
57
63
|
"vitest": "^4.1.9"
|
|
58
64
|
},
|
|
59
65
|
"engines": {
|