From a6a88c76f7dda6ef4c3250099d009cd8bdf0ade2 Mon Sep 17 00:00:00 2001 From: irongut Date: Fri, 18 Feb 2022 01:18:48 +0000 Subject: [PATCH] added sImplecov note to readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9c17ffb..3041af2 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ A GitHub Action that reads Cobertura format code coverage files from your test s Code Coverage Summary is designed for use with [Coverlet](https://github.com/coverlet-coverage/coverlet) and [gcovr](https://github.com/gcovr/gcovr) but it should work with any test framework that outputs coverage in Cobertura format. If it doesn't work with your tooling please [open an issue][new-issue] to discuss the problem. +If you're using [Simplecov](https://github.com/simplecov-ruby/simplecov) please see the [wiki](https://github.com/irongut/CodeCoverageSummary/wiki/Simplecov-Compatibility) for required settings to enable compatibility with Code Coverage Summary. + As a Docker based action Code Coverage Summary requires a Linux runner, see [Types of Action](https://docs.github.com/en/actions/creating-actions/about-custom-actions#types-of-actions). If you need to build with a Windows or MacOS runner a workaround would be to upload the coverage file as an artifact and use a separate job with a Linux runner to generate the summary.