Coverage github actions (PR report + badge)

[y-prudent]

Features

• Add github action to get a report on code coverage for each new PR through a github bot message. 😎 It uses coverage.py to compute the code coverage, and python-coverage to display the report on github. => (python-coverage-report.yml file) Remarks:

  • A threshold of 0.7 has (arbitrary, can be edited) been chosen for code coverage => If coverage score is above this threshold, then the status will be 🟢, else 🔴.
  • 3 coverage scores are displayed: First an overall coverage score, then the coverage of modified files in the current PR and finally the coverage of new files in the current PR
  • Check this image to see how the coverage report would render if some Python files had been modified in the PR (not the case here).

  [Update! 31/05]

• Add github action to generate a coverage badge commited by a github bot on gh-shields orphan branch each time a PR is merged to the master branch. => (python-coverage-shield.yml file) Remarks:
  • If the coverage score remains unchanged when merging to master, the coverage badge is not re-uploaded.
  • By default the badge color depends on the score value, but it can also be set to a plain green color according to preferences.
  • Check README to see how it renders.

[github-actions[bot]]

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
1652	1428	86%	70%	🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 6807c6d by action🐍

[y-prudent]

Ready to be reviewed!