From b9af250554ec9ead96c81fa294fa6e7bc0166e2a Mon Sep 17 00:00:00 2001 From: Michal Dorner Date: Mon, 8 Mar 2021 21:27:44 +0100 Subject: [PATCH] Document mocha-json usage --- README.md | 17 ++++++++++++++++- action.yml | 2 +- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 89c9449..e572940 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ This [Github Action](https://github.com/features/actions) displays test results - .NET / [xUnit](https://xunit.net/) / [NUnit](https://nunit.org/) / [MSTest](https://github.com/Microsoft/testfx-docs) - Dart / [test](https://pub.dev/packages/test) - Flutter / [test](https://pub.dev/packages/test) -- JavaScript / [JEST](https://jestjs.io/) - Java / [JUnit](https://junit.org/) +- JavaScript / [JEST](https://jestjs.io/) / [Mocha](https://mochajs.org/) For more information see [Supported formats](#supported-formats) section. @@ -273,6 +273,21 @@ You can use following example configuration in `package.json`: Configuration of `uniqueOutputName`, `suiteNameTemplate`, `classNameTemplate`, `titleTemplate` is important for proper visualization of test results. +
+ mocha-json + +[Mocha](https://mochajs.org/) testing framework support requires: +- Mocha version [v7.2.0](https://github.com/mochajs/mocha/releases/tag/v7.2.0) or higher +- Usage of [json](https://mochajs.org/#json) reporter. + +You can use following example configuration in `package.json`: +```json +"scripts": { + "test": "mocha --reporter json > test-results.json" +} +``` +
+ ## GitHub limitations Unfortunately there are some known issues and limitations caused by GitHub API: diff --git a/action.yml b/action.yml index a39adda..402c451 100644 --- a/action.yml +++ b/action.yml @@ -1,6 +1,6 @@ name: Test Reporter description: | - Displays test results directly in GitHub. Supports .NET (xUnit, NUnit, MSTest), Dart, Flutter and JavaScript (JEST). + Shows test results in GitHub UI: .NET (xUnit, NUnit, MSTest), Dart, Flutter, Java (JUnit), JavaScript (JEST, Mocha) author: Michal Dorner inputs: artifact: