Skip to content

Comments a pull request with the code coverage generated by your tests.

License

Notifications You must be signed in to change notification settings

andybelltree/lcov-reporter-action

 
 

Repository files navigation

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 Report
FileBranchesFuncsLinesUncovered Lines
src
   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, 26
src/components/release-companies
   index.tsx100%100%100%
src/components/release-credits
   index.tsx85.71%100%91.30%37, 38, 40, 43
src/components/release-format-link
   index.tsx100%100%100%
src/components/release-header
   index.tsx58.33%100%100%79, 80, 82, 85, 86
src/components/release-label-link
   index.tsx100%100%100%
src/components/release-series-link
   index.tsx0%100%100%19
src/components/release-thumbnail
   icon.tsx50%100%83.33%26, 30
   index.tsx75%100%100%42
src/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

working-directory (Default: "")

Path to working directory the same as default shell property

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.

max-uncovered-lines (Optional)

If included, will limit the number of uncovered lines displayed in the Uncovered Lines column.

dont-post-if-no-changed-files-in-report (Optional)

If included, will skip posting a coverage report if no changed files would be included in the report

fail-drop-percent-threshold (Optional)

If included, will fail if coverage drops more than the given percentage

Example usage

uses: romeovs/lcov-reporter-action@v0.2.16
with:
  lcov-file: ./coverage/lcov.info

Acknowledgements

The initial code is based on ziishaned/jest-reporter-action.

Changed file retrieval based on jitterbit/get-changed-files.

About

Comments a pull request with the code coverage generated by your tests.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.5%
  • JavaScript 1.5%