mirror of
https://github.com/dorny/test-reporter.git
synced 2025-12-15 22:07:09 +01:00
Complete documentation for all supported reporters
This commit addresses several documentation gaps to ensure all implemented reporters are properly documented across action.yml and README.md. Changes: 1. Updated action.yml description to include all supported languages: - Added: Go, Python (pytest, unittest), Ruby (RSpec), Swift 2. Added Ruby/RSpec to supported languages list in README.md 3. Added detailed documentation sections in README.md: - dotnet-nunit: Added section with NUnit3 XML format instructions - rspec-json: Added section with RSpec JSON formatter configuration All reporters now have: - Entry in action.yml description - Entry in README supported languages list - Entry in README usage documentation (reporter input) - Detailed documentation section in README "Supported formats" - Implementation in src/main.ts - Tests in __tests__/ This ensures users can discover and use all available reporters without confusion about what is supported. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
cf146f4036
commit
04232af26f
2 changed files with 39 additions and 1 deletions
38
README.md
38
README.md
|
|
@ -20,6 +20,7 @@ This [Github Action](https://github.com/features/actions) displays test results
|
||||||
- Java / [JUnit](https://junit.org/)
|
- Java / [JUnit](https://junit.org/)
|
||||||
- JavaScript / [JEST](https://jestjs.io/) / [Mocha](https://mochajs.org/)
|
- JavaScript / [JEST](https://jestjs.io/) / [Mocha](https://mochajs.org/)
|
||||||
- Python / [pytest](https://docs.pytest.org/en/stable/) / [unittest](https://docs.python.org/3/library/unittest.html)
|
- Python / [pytest](https://docs.pytest.org/en/stable/) / [unittest](https://docs.python.org/3/library/unittest.html)
|
||||||
|
- Ruby / [RSpec](https://rspec.info/)
|
||||||
- Swift / xUnit
|
- Swift / xUnit
|
||||||
|
|
||||||
For more information see [Supported formats](#supported-formats) section.
|
For more information see [Supported formats](#supported-formats) section.
|
||||||
|
|
@ -256,6 +257,22 @@ Supported testing frameworks:
|
||||||
For more information see [dotnet test](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples)
|
For more information see [dotnet test](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples)
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>dotnet-nunit</summary>
|
||||||
|
|
||||||
|
Test execution must be configured to produce [NUnit3](https://docs.nunit.org/articles/nunit/technical-notes/usage/Test-Result-XML-Format.html) XML test results.
|
||||||
|
To get test results in NUnit3 format you can execute your tests with CLI arguments:
|
||||||
|
|
||||||
|
`dotnet test --logger "nunit;LogFileName=test-results.xml"`
|
||||||
|
|
||||||
|
Or you can configure NUnit output in your test project by adding the [NUnit3TestAdapter](https://www.nuget.org/packages/NUnit3TestAdapter) package.
|
||||||
|
|
||||||
|
Supported testing frameworks:
|
||||||
|
- [NUnit](https://nunit.org/)
|
||||||
|
|
||||||
|
For more information see [dotnet test](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples)
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>flutter-json</summary>
|
<summary>flutter-json</summary>
|
||||||
|
|
||||||
|
|
@ -366,6 +383,27 @@ pytest --junit-xml=test-report.xml
|
||||||
For **unittest** support, use a test runner that outputs the JUnit report format, such as [unittest-xml-reporting](https://pypi.org/project/unittest-xml-reporting/).
|
For **unittest** support, use a test runner that outputs the JUnit report format, such as [unittest-xml-reporting](https://pypi.org/project/unittest-xml-reporting/).
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>rspec-json</summary>
|
||||||
|
|
||||||
|
[RSpec](https://rspec.info/) testing framework support requires the usage of JSON formatter.
|
||||||
|
You can configure RSpec to output JSON format by using the `--format json` option and redirecting to a file:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
rspec --format json --out rspec-results.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Or configure it in `.rspec` file:
|
||||||
|
```
|
||||||
|
--format json
|
||||||
|
--out rspec-results.json
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information see:
|
||||||
|
- [RSpec documentation](https://rspec.info/)
|
||||||
|
- [RSpec Formatters](https://relishapp.com/rspec/rspec-core/docs/formatters)
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>swift-xunit (Experimental)</summary>
|
<summary>swift-xunit (Experimental)</summary>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
name: Test Reporter
|
name: Test Reporter
|
||||||
description: |
|
description: |
|
||||||
Shows test results in GitHub UI: .NET (xUnit, NUnit, MSTest), Dart, Flutter, Java (JUnit), JavaScript (JEST, Mocha)
|
Shows test results in GitHub UI: .NET (xUnit, NUnit, MSTest), Dart, Flutter, Go, Java (JUnit), JavaScript (JEST, Mocha), Python (pytest, unittest), Ruby (RSpec), Swift
|
||||||
author: Michal Dorner <dorner.michal@gmail.com>
|
author: Michal Dorner <dorner.michal@gmail.com>
|
||||||
inputs:
|
inputs:
|
||||||
artifact:
|
artifact:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue