@testream/junit-reporter 1.2.1 → 1.2.3
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 -6
- package/dist/cli/index.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +18 -10
package/README.md
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
|
-
# @testream/junit-reporter
|
|
1
|
+
# @testream/junit-reporter: JUnit XML test reporting for Jira
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@testream/junit-reporter` converts JUnit XML to CTRF and publishes the results to Testream as durable, Jira-visible test evidence. It works with Maven, Gradle, Java, and other tools that emit compatible JUnit XML without requiring teams to recreate automated tests as manual Jira cases.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## What the reporter sends to Testream and Jira
|
|
6
|
+
|
|
7
|
+
- Passed, failed, skipped, and timed test results from JUnit XML
|
|
8
|
+
- Failure messages, stack traces, duration, and suite hierarchy
|
|
9
|
+
- Branch, commit, build, environment, and CI metadata
|
|
10
|
+
- Suite changes and historical trends for Jira and release reviews
|
|
11
|
+
|
|
12
|
+
The original framework remains the execution source. Testream provides a consistent evidence model around the XML already produced by the pipeline.
|
|
13
|
+
|
|
14
|
+
## Install and run in CI
|
|
6
15
|
|
|
7
16
|
```yaml
|
|
8
17
|
- uses: actions/setup-java@v4
|
|
@@ -24,7 +33,24 @@ Run JUnit XML conversion and send the results from your codebase to Jira via Tes
|
|
|
24
33
|
--fail-on-error
|
|
25
34
|
```
|
|
26
35
|
|
|
27
|
-
By default, `testream-junit` reads JUnit XML from `target/surefire-reports/TEST-*.xml`.
|
|
28
|
-
|
|
36
|
+
By default, `testream-junit` reads JUnit XML from `target/surefire-reports/TEST-*.xml`. Use `--junit-path` when Maven, Gradle, or another compatible test tool writes reports elsewhere.
|
|
37
|
+
|
|
38
|
+
## JUnit XML evidence in CI/CD
|
|
39
|
+
|
|
40
|
+
Store `TESTREAM_API_KEY` as a protected secret. The command works in GitHub Actions, GitLab CI/CD, Azure Pipelines, Jenkins, and other command-based CI systems. Testream converts and publishes the report after the framework finishes.
|
|
41
|
+
|
|
42
|
+
## Frequently asked questions
|
|
43
|
+
|
|
44
|
+
### Do we need to recreate automated tests as manual Jira cases?
|
|
45
|
+
|
|
46
|
+
No. The framework that generated the JUnit XML remains the execution source. Testream adds Jira reporting without duplicate manual cases.
|
|
47
|
+
|
|
48
|
+
### Is this limited to Java or JUnit itself?
|
|
49
|
+
|
|
50
|
+
No. It accepts compatible JUnit XML from Maven, Gradle, Java frameworks, and other test tools that emit the same report format.
|
|
51
|
+
|
|
52
|
+
## Official Testream resources
|
|
29
53
|
|
|
30
|
-
|
|
54
|
+
- [JUnit Jira integration](https://testream.app/junit-jira-integration)
|
|
55
|
+
- [Complete JUnit reporter setup guide](https://docs.testream.app/reporters/junit)
|
|
56
|
+
- [Install Testream – Automated Test Management for Jira](https://marketplace.atlassian.com/3048460704)
|