python-coverage-comment

WIP 🚧

Create a Coverage report comment on Github PR

Permissions needed for the Github Token:

Pull requests:read Pull requests:write

install:

pip install python-coverage-comment

run:

GITHUB_REPOSITORY=<repository_name> \
COVERAGE_PATH=<path_to_coverage_report> \
GITHUB_TOKEN=<github_token> \
GITHUB_PR_NUMBER=<pull_request_number> \
codecov

Required Environment Variables

• GITHUB_REPOSITORY: The name of the GitHub repository where the action is running.
• COVERAGE_PATH: The path to the coverage report file. (JSON format)
• GITHUB_TOKEN: The GitHub token used for authentication.
• GITHUB_PR_NUMBER: The number of the pull request where the coverage report comment to be generated. (Optional)
• GITHUB_REF: The branch name if pr number is not provided, it will be used to get the PR number. (Optional)

Note: Either GITHUB_PR_NUMBER or GITHUB_REF is required. GITHUB_PR_NUMBER takes precedence if both mentioned.

Optional Environment Variables

• MINIMUM_GREEN: The minimum coverage percentage for green status. Default is 100.
• MINIMUM_ORANGE: The minimum coverage percentage for orange status. Default is 70.
• BRANCH_COVERAGE: Show branch coverage in the report. Default is False.
• ANNOTATE_MISSING_LINES: Whether to annotate missing lines in the coverage report. Default is False.
• ANNOTATION_TYPE: The type of annotation to use for missing lines. 'notice' or 'warning' or 'error'. Default is 'warning'.
• MAX_FILES_IN_COMMENT: The maximum number of files to include in the coverage report comment. Default is 25.
• SKIP_COVERED_FILES_IN_REPORT: Skip the files with coverage 100% from the report. Default is True.
• COMPLETE_PROJECT_REPORT: Whether to include the complete project coverage report in the comment. Default is False.
• COVERAGE_REPORT_URL: URL of the full coverage report to mention in the comment.
• DEBUG: Whether to enable debug mode. Default is False.

Notes

1. The coverage report displays only files that have missing coverage. If all files are fully covered, the report will be empty.
2. When branch coverage is enabled, the coverage percentage is calculated based on the uncovered branches in the affected files.
3. If the complete project report option is enabled, the report is included as-is in the comment, without any modifications or recalculations. If you notice discrepancies between the PR coverage and the complete project coverage, this may be expected. For consistent results, it is recommended to enable branch coverage when your report includes it.

Dev Setup

To get started, follow these steps:

1. Clone the repository:

   git clone <repository_url>

2. Navigate to the cloned repository:

   cd <repository_directory>

3. Install uv if you do not have it yet.

4. Build the project:

   make all

5. Export the required environment variables:

   export GITHUB_REPOSITORY=<repository_name>
   export COVERAGE_PATH=<path_to_coverage_report>
   export GITHUB_TOKEN=<github_token>
   export GITHUB_PR_NUMBER=<pull_request_number>

6. Run the action:

   make run

---

NOTE: This project is inspired from py-cov-action/python-coverage-comment-action, LICENSE with few modifications.

---