diff --git a/README.md b/README.md index f476072..aa44573 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ -# JUnit Check Report +**WIP** -** WIP ** \ No newline at end of file +# Test Check Report + +Goal of this project is to create [Github Action](https://github.com/features/actions) +that could presents test results from popular testing frameworks as Github check run with code annotation in places where test failed. + +Support for following test reports are planned for initial release: +- [ ] dotnet-trx: [`dotnet test --logger trx`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples) +- [ ] flutter-machine: `flutter test --machine` +- [ ] jest-junit: [`jest --ci --reporters=jest-junit`](https://github.com/jest-community/jest-junit#readme) diff --git a/action.yml b/action.yml index e0c0f1c..86285df 100644 --- a/action.yml +++ b/action.yml @@ -1,7 +1,26 @@ -name: 'JUnit Check Report' -description: 'Presents results of junit test report as Github check run' +name: 'Test Check Reporter' +description: | + Presents test results from popular testing frameworks as Github check run. + Supports: + - dotnet (trx logger) + - flutter (JSON output with '--machine' flag ) + - jest (jest-junit reporter) + author: 'Michal Dorner ' inputs: + name: + description: 'Name of the check run' + required: true + path: + description: 'Path to test report' + required: true + reporter: + description: | + Format of test report. Supported options: + - dotnet-trx + - flutter-machine + - jest-junit + required: true token: description: 'GitHub Access Token' required: false diff --git a/package.json b/package.json index 7595ef4..484d0ab 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "junit-check", "version": "0.0.0", "private": true, - "description": "Presents results of junit test report as Github check run", + "description": "Presents test results from popular testing frameworks as Github check run", "main": "lib/main.js", "scripts": { "build": "tsc", @@ -15,7 +15,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/dorny/junit-check.git" + "url": "git+https://github.com/dorny/test-check.git" }, "keywords": [ "actions",