From ac37b8e9b7641912dcdd6b3dac977afd6951abe9 Mon Sep 17 00:00:00 2001 From: irongut Date: Tue, 26 Oct 2021 23:08:13 +0100 Subject: [PATCH] prepare v1.1.0-beta release --- README.md | 39 +++++++++++++++---- action.yml | 2 +- .../CodeCoverageSummary.csproj | 2 +- 3 files changed, 33 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b41dcb9..2ced22a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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. -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 seperate job with a Linux runner to generate the 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. ## Inputs @@ -19,12 +19,30 @@ Note: Coverlet creates the coverage file in a random named directory (guid) so y Include a badge reporting the Line Rate coverage in the output using [shields.io](https://shields.io/) - `true` or `false` (default). -If the overall Line Rate is less than 50% the badge will be red, if it is 50% - 74% it will be yellow and if it is 75% or over it will be green. +If the overall Line Rate is less than the lower threshold (50%) the badge will be red, if it is between thresholds it will be yellow and if it greater than or equal to the higher threshold (75%) it will be green. See [`thresholds`](#thresholds) to change these values. + +#### `fail_below_min` +**v1.1.0-beta only** + +Fail the workflow if the overall Line Rate is below lower threshold - `true` or `false` (default). The default lower threshold is 50%, see [`thresholds`](#thresholds). #### `format` Output Format - `markdown` or `text` (default). +#### `indicators` +**v1.1.0-beta only** + +Include health indicators in the output - `true` (default) or `false`.' + +Line Rate | Indicator +--------- | --------- +less than lower threshold (50%) | ❌ +between thresholds (50% - 74%) | ➖ +equal or greater than upper threshold (75%) | ✔ + +See [`thresholds`](#thresholds) to change these values. + #### `output` Output Type - `console` (default), `file` or `both`. @@ -35,16 +53,21 @@ Output Type - `console` (default), `file` or `both`. `both` will output the coverage summary to the Action log and a file as above. +#### `thresholds` +**v1.1.0-beta only** + +Lower and upper threshold percentages for badge and health indicators, lower threshold can also be used to fail the action. Separate the values with a space and enclose them in quotes; default `'50 75'`. + ## Outputs #### Text Example ``` -https://img.shields.io/badge/Code%20Coverage-77%25-success?style=flat -Line Rate = 77%, Lines Covered = 1107 / 1433 -Branch Rate = 60%, Branches Covered = 321 / 532 -Complexity = 917 -Company.Example: Line Rate = 78%, Branch Rate = 60%, Complexity = 906 -Company.Example.Library: Line Rate = 27%, Branch Rate = 100%, Complexity = 11 +https://img.shields.io/badge/Code%20Coverage-83%25-success?style=flat + +Company.Example: Line Rate = 83%, Branch Rate = 69%, Complexity = 671, ✔ +Company.Example.Library: Line Rate = 27%, Branch Rate = 100%, Complexity = 11, ❌ +Summary: Line Rate = 83% (1212 / 1460), Branch Rate = 69% (262 / 378), Complexity = 682, ✔ +Minimum allowed line rate is 50% ``` #### Markdown Example diff --git a/action.yml b/action.yml index 9096f18..0775000 100644 --- a/action.yml +++ b/action.yml @@ -34,7 +34,7 @@ inputs: default: '50 75' runs: using: 'docker' - image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.0.5' + image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.1.0-beta' args: - ${{ inputs.filename }} - '--badge' diff --git a/src/CodeCoverageSummary/CodeCoverageSummary.csproj b/src/CodeCoverageSummary/CodeCoverageSummary.csproj index ad18de5..1364297 100644 --- a/src/CodeCoverageSummary/CodeCoverageSummary.csproj +++ b/src/CodeCoverageSummary/CodeCoverageSummary.csproj @@ -14,7 +14,7 @@ https://github.com/irongut/CodeCoverageSummary git coverage test-coverage cobertura action code-coverage coverlet github-actions - 1.0.5 + 1.1.0