Skip to content

Commit

Permalink
Readme file update
Browse files Browse the repository at this point in the history
  • Loading branch information
niwciu committed Sep 10, 2024
1 parent f9f2d8a commit 371238f
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ For more information, see [action.yml](./action.yml) and [GitHub Actions guide](
| `gcov-executable` | Executable name with optional arguments | Use a particular [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) executable. Must match the compiler you are using, e.g. `llvm-cov gcov` for [LLVM Clang](https://clang.llvm.org/). See [this](https://gcovr.com/en/stable/guide/compiling.html#choosing-the-right-gcov-executable). |
| `excludes` | One or more regular expression | Exclude source files that match these filters. |
| `fail-under-line` | 0 - 100 | Fail if the total line coverage is less than this value. |
| `html-out` | Path | Output file of the generated HTML coverage report. |
| `html-theme` | `green` , `blue` , `github.blue` , `github.green` , `github.dark-green` , `github.dark-blue` | Override the default color theme for the HTML report. |
| `xml-out` | Path | Output file of the generated XML coverage report. |
| `coveralls-out` | Path | Output file of the generated [Coveralls API](https://docs.coveralls.io/api-introduction) coverage report. |
| `coveralls-send` | `true` or `false` | Send the generated Coveralls API coverage report to it's endpoint. Defaults to `false`. |
Expand Down Expand Up @@ -63,6 +65,25 @@ jobs:
src/internal/*
```
#### Output HTML Report
```yaml
- name: Generate a html code coverage report
uses: threeal/gcovr-action@xml-out
with:
html-out: coverage.html
```
#### Output HTML Report generated with a specific theme
```yaml
- name: Generate a html code coverage report
uses: threeal/gcovr-action@xml-out
with:
html-out: coverage.html
html-theme: github.green
```
#### Output XML Report
```yaml
Expand Down

0 comments on commit 371238f

Please sign in to comment.