Skip to content

Commit 9ef5c13

Browse files
authored
Merge pull request #691 from dorny/fix/complete-documentation
2 parents 83e20c1 + 4331a3b commit 9ef5c13

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This [Github Action](https://github.com/features/actions) displays test results
2020
- Java / [JUnit](https://junit.org/)
2121
- JavaScript / [JEST](https://jestjs.io/) / [Mocha](https://mochajs.org/)
2222
- Python / [pytest](https://docs.pytest.org/en/stable/) / [unittest](https://docs.python.org/3/library/unittest.html)
23+
- Ruby / [RSpec](https://rspec.info/)
2324
- Swift / xUnit
2425

2526
For more information see [Supported formats](#supported-formats) section.
@@ -256,6 +257,20 @@ Supported testing frameworks:
256257
For more information see [dotnet test](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples)
257258
</details>
258259

260+
<details>
261+
<summary>dotnet-nunit</summary>
262+
263+
Test execution must be configured to generate [NUnit3](https://docs.nunit.org/articles/nunit/technical-notes/usage/Test-Result-XML-Format.html) XML test results.
264+
Install the [NUnit3TestAdapter](https://www.nuget.org/packages/NUnit3TestAdapter) package (required; it registers the `nunit` logger for `dotnet test`), then run tests with:
265+
266+
`dotnet test --logger "nunit;LogFileName=test-results.xml"`
267+
268+
Supported testing frameworks:
269+
- [NUnit](https://nunit.org/)
270+
271+
For more information see [dotnet test](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples)
272+
</details>
273+
259274
<details>
260275
<summary>flutter-json</summary>
261276

@@ -366,6 +381,27 @@ pytest --junit-xml=test-report.xml
366381
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/).
367382
</details>
368383

384+
<details>
385+
<summary>rspec-json</summary>
386+
387+
[RSpec](https://rspec.info/) testing framework support requires the usage of JSON formatter.
388+
You can configure RSpec to output JSON format by using the `--format json` option and redirecting to a file:
389+
390+
```shell
391+
rspec --format json --out rspec-results.json
392+
```
393+
394+
Or configure it in `.rspec` file:
395+
```
396+
--format json
397+
--out rspec-results.json
398+
```
399+
400+
For more information see:
401+
- [RSpec documentation](https://rspec.info/)
402+
- [RSpec Formatters](https://relishapp.com/rspec/rspec-core/docs/formatters)
403+
</details>
404+
369405
<details>
370406
<summary>swift-xunit (Experimental)</summary>
371407

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Test Reporter
22
description: |
3-
Shows test results in GitHub UI: .NET (xUnit, NUnit, MSTest), Dart, Flutter, Java (JUnit), JavaScript (JEST, Mocha)
3+
Shows test results in GitHub UI: .NET (xUnit, NUnit, MSTest), Dart, Flutter, Go, Java (JUnit), JavaScript (JEST, Mocha), Python (pytest, unittest), Ruby (RSpec), Swift
44
author: Michal Dorner <dorner.michal@gmail.com>
55
inputs:
66
artifact:

0 commit comments

Comments
 (0)