From 04232af26fd55a4fb2ab3c97489dc14c7ec3445b Mon Sep 17 00:00:00 2001 From: Jozef Izso Date: Sat, 22 Nov 2025 18:05:33 +0100 Subject: [PATCH] Complete documentation for all supported reporters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ action.yml | 2 +- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7c7153..24c1c12 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ This [Github Action](https://github.com/features/actions) displays test results - Java / [JUnit](https://junit.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) +- Ruby / [RSpec](https://rspec.info/) - Swift / xUnit 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) +
+ dotnet-nunit + +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) +
+
flutter-json @@ -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/).
+
+ rspec-json + +[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) +
+
swift-xunit (Experimental) diff --git a/action.yml b/action.yml index 9b20aff..e361cb8 100644 --- a/action.yml +++ b/action.yml @@ -1,6 +1,6 @@ name: Test Reporter 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 inputs: artifact: