@testream/dotnet-reporter 1.2.2 → 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 CHANGED
@@ -1,8 +1,18 @@
1
- # @testream/dotnet-reporter
1
+ # @testream/dotnet-reporter: .NET test reporting for Jira
2
2
 
3
- Run .NET tests and send the results from your codebase to Jira via Testream.
3
+ `@testream/dotnet-reporter` runs .NET tests or ingests TRX, then publishes xUnit, NUnit, and MSTest results to Testream as durable evidence visible from Jira. Your C# test suite remains the execution source, with no need to recreate every automated test as a manual Jira case.
4
4
 
5
- ## CI Example (GitHub Actions)
5
+ ## What the reporter sends to Testream and Jira
6
+
7
+ - xUnit, NUnit, and MSTest results read from TRX
8
+ - Failure messages, stack traces, duration, and suite structure
9
+ - Bounded C# method snippets when TRX source paths can be resolved
10
+ - Branch, commit, build, environment, and CI metadata
11
+ - Suite changes and trends for Jira and release reviews
12
+
13
+ Testream connects .NET execution to the delivery work teams already manage in Jira without replacing the existing test project or pipeline.
14
+
15
+ ## Install and run in CI
6
16
 
7
17
  ```yaml
8
18
  - uses: actions/setup-dotnet@v4
@@ -21,8 +31,24 @@ Run .NET tests and send the results from your codebase to Jira via Testream.
21
31
  --fail-on-error
22
32
  ```
23
33
 
24
- This installs the reporter, runs your .NET tests, and uploads results to Testream.
25
- When TRX metadata includes source file paths, the reporter also enriches CTRF
26
- tests with bounded C# method snippets from the corresponding `.cs` files.
34
+ This installs the reporter, runs the .NET tests, and publishes their results. When TRX metadata includes source file paths, the reporter enriches CTRF tests with bounded C# method snippets from the corresponding `.cs` files.
35
+
36
+ ## .NET evidence in CI/CD
37
+
38
+ Store `TESTREAM_API_KEY` as a protected secret. The command works in GitHub Actions, Azure Pipelines, GitLab CI/CD, Jenkins, and other command-based CI providers, preserving build and source context for later Jira review.
39
+
40
+ ## Frequently asked questions
41
+
42
+ ### Do we need to recreate automated tests as manual Jira cases?
43
+
44
+ No. xUnit, NUnit, or MSTest remains the code-first execution source. Testream adds Jira visibility without duplicate manual cases.
45
+
46
+ ### Can the reporter ingest an existing TRX file?
47
+
48
+ Yes. The reporter supports TRX produced by an existing .NET test workflow as well as running tests within its normal command flow.
49
+
50
+ ## Official Testream resources
27
51
 
28
- For CLI options and CI examples, see https://docs.testream.app/reporters/dotnet.
52
+ - [.NET Jira integration](https://testream.app/dotnet-jira-integration)
53
+ - [Complete .NET reporter setup guide](https://docs.testream.app/reporters/dotnet)
54
+ - [Install Testream – Automated Test Management for Jira](https://marketplace.atlassian.com/3048460704)