Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romeovs/lcov-reporter-action
Comments a pull request with the code coverage generated by your tests.
https://github.com/romeovs/lcov-reporter-action
Last synced: 3 months ago
JSON representation
Comments a pull request with the code coverage generated by your tests.
- Host: GitHub
- URL: https://github.com/romeovs/lcov-reporter-action
- Owner: romeovs
- License: mit
- Fork: true (ziishaned/jest-reporter-action)
- Created: 2020-02-27T14:14:26.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T15:56:58.000Z (4 months ago)
- Last Synced: 2024-10-25T08:53:35.787Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.04 MB
- Stars: 161
- Watchers: 4
- Forks: 100
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - romeovs/lcov-reporter-action - Comments a pull request with the code coverage generated by your tests. (JavaScript)
- awesome-list - lcov-reporter-action
README
> [!WARNING]
> This project is not actively maintained.
# Lcov reporter action
This action comments a pull request with a HTML test coverage report.
The report is based on the lcov coverage report generated by your test runner.
Note that this action does not run any tests, but instead expects the tests to have been run
by another action already.
## Example output
Total Coverage: 99.39%
Coverage ReportFileBranchesFuncsLinesUncovered Linessrc i18n.tsx100%100%100%src/components/i18n context.tsx100%100%100% hydrate.tsx100%100%100% index.tsx85.71%88.89%100%54 link.tsx100%100%100%src/components/icon index.tsx100%100%100% props.tsx100%100%100%src/components/layout index.tsx100%100%100%src/components/release-artist-link index.tsx66.67%100%100%24, 25, 26src/components/release-companies index.tsx100%100%100%src/components/release-credits index.tsx85.71%100%91.30%37, 38, 40, 43src/components/release-format-link index.tsx100%100%100%src/components/release-header index.tsx58.33%100%100%79, 80, 82, 85, 86src/components/release-label-link index.tsx100%100%100%src/components/release-series-link index.tsx0%100%100%19src/components/release-thumbnail icon.tsx50%100%83.33%26, 30 index.tsx75%100%100%42src/components/search index.tsx100%100%100% mock.tsx100%100%100% ui.tsx100%100%100%src/lib add-state.tsx100%100%100% intersperse.tsx100%100%100% keycodes.tsx100%100%100% slug.tsx100%100%100%src/services autocomplete.tsx100%100%100%
## Inputs
##### `github-token` (**Optional**)
Github token used for posting the comment. Defaults to `${{ github.token }}`.
For alternative `github-token` values see: [Creating Personal Access Tokens](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
##### `working-directory` (**Default: ""**)
Path to working directory the same as [default shell property](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)
##### `lcov-file` (**Optional**)
The location of the lcov file to read the coverage report from. Defaults to
`./coverage/lcov.info`. Path is relative to **working-directory** input
##### `lcov-base` (**Optional**)
The location of the lcov file resulting from running the tests in the base
branch. When this is set a diff of the coverage percentages is shown.
##### `filter-changed-files` (**Default: false**)
If set to true, only changed files will be included in the report. Total percentage will still include all files.
##### `delete-old-comments` (**Default: false**)
If set to true, old comments will be deleted before a new comment is posted
##### `title` (**Optional**)
If included, will be added as a title for the comment produced.
## Example usage
```yml
uses: romeovs/[email protected]
with:
lcov-file: ./coverage/lcov.info
```
## Acknowledgements
The initial code is based on [ziishaned/jest-reporter-action](https://github.com/ziishaned/jest-reporter-action).
Changed file retrieval based on [jitterbit/get-changed-files](https://github.com/jitterbit/get-changed-files).