Skip to content

Add Codecov CI / comment report in each PR #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbillinge merged 3 commits into from
Nov 5, 2024
Merged

Add Codecov CI / comment report in each PR #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96abb4d
Add codecov report upload
bobleesj Nov 2, 2024
765d5e1
Add secrets.Codecov to test-on-pr.yml temp
bobleesj Nov 2, 2024
4eb5718
Apply pre-commit
bobleesj Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions .github/workflows/_tests-on-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ on:
default: false
required: false
type: boolean
secrets:
CODECOV_TOKEN:
description: 'Codecov token'
required: true

jobs:
validate:
Expand Down Expand Up @@ -64,6 +68,14 @@ jobs:
run: |
if ${{ inputs.headless }}; then
export DISPLAY=:99

fi
python -m pytest
pytest --cov
coverage report -m
codecov

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4
Copy link
Contributor Author

@bobleesj bobleesj Nov 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uploading to the branch within Codecov.io other than main to generate the PR comment. This approach ensures that the user-facing main branch coverage remains unaffected during a PR:

I have tested using a dummy package:

branch:

https://app.codecov.io/gh/bobleesj-test-org/bobleesj.release/commits/test-codecov

main:

https://app.codecov.io/gh/bobleesj-test-org/bobleesj.release/commits/main

with:
verbose: true
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
2 changes: 2 additions & 0 deletions .github/workflows/templates/tests-on-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ jobs:
project: {{ PROJECT/PROJECT_NAME }}
c_extension: {{ C_EXTENSION/false }}
headless: {{ HEADLESS/false }}
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}