Skip to content

Commit 5088d5e

Browse files
committed
prepare v1.2.0 release
1 parent ee53bdd commit 5088d5e

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@ As a Docker based action Code Coverage Summary requires a Linux runner, see [Typ
2424
### `filename`
2525
**Required**
2626

27-
Code coverage file to analyse.
27+
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.
2828

29-
**v1.2.0-beta only:** A comma separated list of code coverage files to analyse.
30-
31-
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 5 Workflow Example](#net-5-workflow-example) below.
29+
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.
3230

3331

3432
### `badge`
@@ -55,13 +53,11 @@ Output Format - `markdown` or `text` (default).
5553

5654

5755
### `hide_branch_rate`
58-
**v1.2.0-beta only**
5956

6057
Hide Branch Rate values in the output - `true` or `false` (default).
6158

6259

6360
### `hide_complexity`
64-
**v1.2.0-beta only**
6561

6662
Hide Complexity values in the output - `true` or `false` (default).
6763

@@ -117,22 +113,24 @@ Minimum allowed line rate is 50%
117113
> Company.Example | 83% | 69% | 671 | ✔
118114
> Company.Example.Library | 27% | 100% | 11 | ❌
119115
> **Summary** | **83%** (1212 / 1460) | **69%** (262 / 378) | 682 | ✔
116+
>
117+
> _Minimum allowed line rate is `50%`_
120118
121119

122120
## Usage
123121

124122
```yaml
125123
name: Code Coverage Summary Report
126-
uses: irongut/CodeCoverageSummary@v1.1.0
124+
uses: irongut/CodeCoverageSummary@v1.2.0
127125
with:
128-
filename: coverage/coverage.cobertura.xml
126+
filename: coverage.cobertura.xml
129127
```
130128
131129
132-
### .Net 5 Workflow Example
130+
### .Net Workflow Example
133131
134132
```yaml
135-
name: .Net 5 CI Build
133+
name: .Net 6 CI Build
136134

137135
on:
138136
push:
@@ -151,7 +149,7 @@ jobs:
151149
- name: Setup .NET
152150
uses: actions/setup-dotnet@v1
153151
with:
154-
dotnet-version: 5.0.x
152+
dotnet-version: 6.0.x
155153

156154
- name: Restore Dependencies
157155
run: dotnet restore src/Example.sln
@@ -163,17 +161,20 @@ jobs:
163161
run: dotnet test src/Example.sln --configuration Release --no-build --verbosity normal --collect:"XPlat Code Coverage" --results-directory ./coverage
164162

165163
- name: Copy Coverage To Predictable Location
166-
run: cp coverage/**/coverage.cobertura.xml coverage/coverage.cobertura.xml
164+
run: cp coverage/**/coverage.cobertura.xml coverage.cobertura.xml
167165

168166
- name: Code Coverage Summary Report
169-
uses: irongut/CodeCoverageSummary@v1.1.0
167+
uses: irongut/CodeCoverageSummary@v1.2.0
170168
with:
171-
filename: coverage/coverage.cobertura.xml
169+
filename: coverage.cobertura.xml
172170
badge: true
173171
fail_below_min: true
174-
format: 'markdown'
175-
output: 'both'
176-
thresholds: '70 80'
172+
format: markdown
173+
hide_branch_rate: false
174+
hide_complexity: true
175+
indicators: true
176+
output: both
177+
thresholds: '60 80'
177178

178179
- name: Add Coverage PR Comment
179180
uses: marocchino/sticky-pull-request-comment@v2

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ inputs:
4242
default: '50 75'
4343
runs:
4444
using: 'docker'
45-
image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.2.0-beta'
45+
image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.2.0'
4646
args:
4747
- '--files'
4848
- ${{ inputs.filename }}

0 commit comments

Comments
 (0)