@testream/junit-reporter 0.1.0 → 1.0.0

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.
Files changed (12) hide show
  1. package/README.md +21 -6
  2. package/dist/cli/converter.d.ts +1 -0
  3. package/dist/cli/converter.d.ts.map +1 -1
  4. package/dist/cli/index.js +1 -1
  5. package/dist/cli/types.d.ts +2 -2
  6. package/dist/cli/types.d.ts.map +1 -1
  7. package/dist/converter.d.ts +1 -0
  8. package/dist/converter.d.ts.map +1 -1
  9. package/dist/index.js +1 -1
  10. package/dist/types.d.ts +2 -2
  11. package/dist/types.d.ts.map +1 -1
  12. package/package.json +1 -1
package/README.md CHANGED
@@ -2,14 +2,29 @@
2
2
 
3
3
  Run JUnit XML conversion and send the results from your codebase to Jira via Testream.
4
4
 
5
- ## Quick Start
5
+ ## CI Example (GitHub Actions)
6
6
 
7
- ```bash
8
- npx @testream/junit-reporter \
9
- --junit-path "./target/surefire-reports/*.xml" \
10
- --api-key $TESTREAM_API_KEY
7
+ ```yaml
8
+ - uses: actions/setup-java@v4
9
+ with:
10
+ distribution: temurin
11
+ java-version: '17'
12
+
13
+ - uses: actions/setup-node@v4
14
+ with:
15
+ node-version: '20'
16
+
17
+ - run: npm install -g @testream/junit-reporter
18
+
19
+ - run: mvn -B test -Dmaven.test.failure.ignore=true
20
+
21
+ - run: |
22
+ testream-junit \
23
+ --api-key "${{ secrets.TESTREAM_API_KEY }}" \
24
+ --fail-on-error
11
25
  ```
12
26
 
13
- This command converts JUnit XML to CTRF and uploads results so they show up in Jira.
27
+ By default, `testream-junit` reads JUnit XML from `target/surefire-reports/TEST-*.xml`.
28
+ Use `--junit-path` only if your reports are in a different location.
14
29
 
15
30
  For CLI options and CI examples, see https://testream.github.io/docs/reporters/junit.
package/dist/cli/converter.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  import { JUnitConversionOptions, JUnitConversionResult } from './types';
2
+ export declare const DEFAULT_JUNIT_PATH = "target/surefire-reports/TEST-*.xml";
2
3
  export declare function convertJUnitToCtrf(options: JUnitConversionOptions): Promise<JUnitConversionResult>;
package/dist/cli/converter.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"","sourceRoot":"","sources":["file:///home/runner/work/jira-test-manager/jira-test-manager/packages/junit-reporter/src/converter.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AA+PxE,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAuBxG"}
1
+ {"version":3,"file":"","sourceRoot":"","sources":["file:///home/runner/work/jira-test-manager/jira-test-manager/packages/junit-reporter/src/converter.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAGxE,eAAO,MAAM,kBAAkB,uCAAuC,CAAC;AA6PvE,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAwBxG"}