mirror of
https://github.com/dorny/test-reporter.git
synced 2025-12-15 13:57:09 +01:00
Document mocha-json usage
This commit is contained in:
parent
9db99178aa
commit
b9af250554
2 changed files with 17 additions and 2 deletions
17
README.md
17
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.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>mocha-json</summary>
|
||||
|
||||
[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"
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
## GitHub limitations
|
||||
|
||||
Unfortunately there are some known issues and limitations caused by GitHub API:
|
||||
|
|
|
|||
|
|
@ -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 <dorner.michal@gmail.com>
|
||||
inputs:
|
||||
artifact:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue