Skip to content

Commit

Permalink
feat: Prepare for release (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
WebDucer authored Jul 29, 2024
1 parent 4a60787 commit 17462d6
Show file tree
Hide file tree
Showing 6 changed files with 4,453 additions and 9 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
# LCOV reporter for GitHub actions
# LCOV reporter for GitHub Actions

[![GitHub Super-Linter](https://github.com/Richter-Consulting/wd-lcov-reporter-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![CI](https://github.com/Richter-Consulting/wd-lcov-reporter-action/actions/workflows/ci.yml/badge.svg)
[![Check dist/](https://github.com/Richter-Consulting/wd-lcov-reporter-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/Richter-Consulting/wd-lcov-reporter-action/actions/workflows/check-dist.yml)
[![CodeQL](https://github.com/Richter-Consulting/wd-lcov-reporter-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Richter-Consulting/wd-lcov-reporter-action/actions/workflows/codeql-analysis.yml)
[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)

A simple action that parse the core data from LCOV file (line, function and
block coverage). The out put variables provide basic data to use in PR comments
or run output.

## Example for configuration

```yaml
- name: LCOV parser
id: lcov-result
uses: Richter-Consulting/wd-lcov-reporter
with:
lcov-file: './coverage/lcov.info'
excluded-files: '**/*.g.dart, **/*.freezed.dart, **/.realm.dart'
```
### Configuration parameters
## TODO
- [ ] Parse lcov file, so it is easier to handle the results
- [ ] Provide following outputs
- [x] Parse lcov file, so it is easier to handle the results
- [x] Provide following outputs
- Markdown table with code coverage per test file
- Overall coverage
2 changes: 1 addition & 1 deletion badges/coverage.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 17462d6

Please sign in to comment.