Skip to content

Commit 51cc3a7

Browse files
committed
prepare v1.3.0 release
1 parent df43d7d commit 51cc3a7

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,9 @@
1414

1515
A GitHub Action that reads Cobertura format code coverage files from your test suite and outputs a text or markdown summary. This summary can be posted as a Pull Request comment or included in Release Notes by other actions to give you an immediate insight into the health of your code without using a third-party site.
1616

17-
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.
17+
Code Coverage Summary is designed for use with any test framework that outputs coverage in Cobertura XML format including [Coverlet](https://github.com/coverlet-coverage/coverlet), [gcovr](https://github.com/gcovr/gcovr), [simplecov](https://github.com/simplecov-ruby/simplecov) and [MATLAB](https://uk.mathworks.com/help/matlab/ref/matlab.unittest.plugins.codecoverageplugin-class.html). See the [FAQ](https://github.com/irongut/CodeCoverageSummary/wiki/Frequently-Asked-Questions#which-testing-tools-does-ccs-work-with) for more details. If it doesn't work with your tooling please [open an issue][new-issue] to discuss the problem.
1818

19-
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.
20-
21-
**v1.3.0-beta only:** Code Coverage Summary should now be compatible with simplecov using the default settings as well as MATLAB's code coverage plugin.
19+
Code Coverage Summary is compatible with [StepSecurity Secure Workflows](https://github.com/step-security/secure-workflows) and uses a Docker image that is cryptographically signed using [Sigstore](https://www.sigstore.dev/). For instructions how to verify the Docker image please see the [Wiki](https://github.com/irongut/CodeCoverageSummary/wiki/Verify-the-Docker-Image).
2220

2321
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.
2422

@@ -28,9 +26,7 @@ As a Docker based action Code Coverage Summary requires a Linux runner, see [Typ
2826
### `filename`
2927
**Required**
3028

31-
A comma separated list of code coverage files to analyse. If there are any spaces in a path or filename this value must be in quotes.
32-
33-
**v1.3.0-beta only:** Also supports using glob patterns to match multiple files.
29+
A comma separated list of code coverage files to analyse. Also supports using glob patterns to match multiple files. If there are any spaces in a path or filename this value must be in quotes.
3430

3531
Note: Coverlet creates the coverage file in a random named directory (guid) so you need to copy it to a predictable path before running this Action, see the [.Net Workflow Example](#net-workflow-example) below.
3632

@@ -60,12 +56,12 @@ Output Format - `markdown` or `text` (default).
6056

6157
### `hide_branch_rate`
6258

63-
Hide Branch Rate values in the output - `true` or `false` (default).
59+
Hide Branch Rate metrics in the output - `true` or `false` (default).
6460

6561

6662
### `hide_complexity`
6763

68-
Hide Complexity values in the output - `true` or `false` (default).
64+
Hide Complexity metrics in the output - `true` or `false` (default).
6965

7066

7167
### `indicators`
@@ -127,7 +123,7 @@ Minimum allowed line rate is 50%
127123

128124
```yaml
129125
name: Code Coverage Summary Report
130-
uses: irongut/CodeCoverageSummary@v1.2.0
126+
uses: irongut/CodeCoverageSummary@v1.3.0
131127
with:
132128
filename: coverage.cobertura.xml
133129
```
@@ -170,7 +166,7 @@ jobs:
170166
run: cp coverage/**/coverage.cobertura.xml coverage.cobertura.xml
171167

172168
- name: Code Coverage Summary Report
173-
uses: irongut/CodeCoverageSummary@v1.2.0
169+
uses: irongut/CodeCoverageSummary@v1.3.0
174170
with:
175171
filename: coverage.cobertura.xml
176172
badge: true

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ branding:
66
color: purple
77
inputs:
88
filename:
9-
description: 'A comma separated list of code coverage files to analyse. Also accepts glob patterns.'
9+
description: 'A comma separated list of code coverage files to analyse. Also supports using glob patterns to match multiple files.'
1010
required: true
1111
badge:
1212
description: 'Include a Line Rate coverage badge in the output using shields.io - true / false (default).'
@@ -42,7 +42,7 @@ inputs:
4242
default: '50 75'
4343
runs:
4444
using: 'docker'
45-
image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.3.0-beta'
45+
image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.3.0'
4646
args:
4747
- '--files'
4848
- ${{ inputs.filename }}

0 commit comments

Comments
 (0)