Skip to content

Commit

Permalink
prepare v1.3.0-beta release
Browse files Browse the repository at this point in the history
  • Loading branch information
irongut committed Jul 26, 2022
1 parent 21fb9f6 commit 8accb9d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Code Coverage Summary is designed for use with [Coverlet](https://github.com/cov

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.

**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.

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.


Expand All @@ -28,6 +30,8 @@ As a Docker based action Code Coverage Summary requires a Linux runner, see [Typ

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.

**v1.3.0-beta only:** Also supports using glob patterns to match multiple files.

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.


Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ branding:
color: purple
inputs:
filename:
description: 'A comma separated list of code coverage files to analyse.'
description: 'A comma separated list of code coverage files to analyse. Also accepts glob patterns.'
required: true
badge:
description: 'Include a Line Rate coverage badge in the output using shields.io - true / false (default).'
Expand Down Expand Up @@ -42,7 +42,7 @@ inputs:
default: '50 75'
runs:
using: 'docker'
image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.2.0'
image: 'docker://ghcr.io/irongut/codecoveragesummary:v1.3.0-beta'
args:
- '--files'
- ${{ inputs.filename }}
Expand Down
4 changes: 2 additions & 2 deletions src/CodeCoverageSummary/CodeCoverageSummary.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<Company>Taranis Software</Company>
<Authors>Irongut</Authors>
<Description>A GitHub Action that reads Cobertura format code coverage files and outputs a text or markdown summary.</Description>
<Copyright>Copyright © 2021 Taranis Software</Copyright>
<Copyright>Copyright © 2021 - 2022 Taranis Software</Copyright>
<PackageId>Taranis.CodeCoverageSummary</PackageId>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/irongut/CodeCoverageSummary</PackageProjectUrl>
<RepositoryUrl>https://github.com/irongut/CodeCoverageSummary</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageTags>coverage test-coverage cobertura action code-coverage coverlet github-actions</PackageTags>
<Version>1.2.0</Version>
<Version>1.3.0</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/CodeCoverageSummary/CommandLineOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace CodeCoverageSummary
{
public class CommandLineOptions
{
[Option(longName: "files", Separator = ',', Required = true, HelpText = "A comma separated list of code coverage files to analyse.")]
[Option(longName: "files", Separator = ',', Required = true, HelpText = "A comma separated list of code coverage files to analyse. Also accepts glob patterns.")]
public IEnumerable<string> Files { get; set; }

[Option(longName: "badge", Required = false, HelpText = "Include a Line Rate coverage badge in the output using shields.io - true or false.", Default = "false")]
Expand Down

0 comments on commit 8accb9d

Please sign in to comment.