Skip to content

Reports coverage measured by coveragepy as annotations to via Check Runs GitHub API

License

Notifications You must be signed in to change notification settings

KOLANICH-GHActions/coveragepyReport

Repository files navigation

coveragepy to Github Checks API reporter Unlicensed work

This action is needed to report coverage of python packages collected by coveragepy.

There are some services for reporting coverage. Such as coveralls and codecov. They have drawbacks:

So we have a different approach. GitHub has a feature allowing custom apps to annotate source code with warnings. So we just create annotations for uncovered lines.

All this is implemented in coverage2GHChecksAnnotations.py python package, if you don't want to use this action, you can use it in your workflows as you like.

This Action assummes python packaging system being already bootstrapped.

It is strongly recommended not to use the snippet below, but to fork this repo (and all the libs used) and audit it and use your fork in your projects.

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]

jobs:
  build:
    runs-on: ubuntu-20.04
    steps:
      - name: annotate the stuff with coverage info
        uses: KOLANICH-GHActions/coveragepyReport@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

About

Reports coverage measured by coveragepy as annotations to via Check Runs GitHub API

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published