ci(coverage): adding mandatory 80% level of coverage for diff (#239)#288
Open
guzmud wants to merge 3 commits into
Open
ci(coverage): adding mandatory 80% level of coverage for diff (#239)#288guzmud wants to merge 3 commits into
guzmud wants to merge 3 commits into
Conversation
❌ 2 Tests Failed:
View the top 2 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
There was a problem hiding this comment.
Pull request overview
This PR introduces Codecov configuration and CI workflow updates to enforce a minimum coverage threshold on new/changed code, publish test results, and document the project’s quality gates for contributors.
Changes:
- Add
codecov.ymlto enforce a patch (diff) coverage target of 80%. - Update the coverage GitHub Actions workflow to generate
junit.xmland upload test results to Codecov. - Document CI quality checks and add
junit.xmlto.gitignore.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Documents CI code-quality and coverage expectations for contributors. |
| codecov.yml | Configures Codecov status checks (project informational, patch target 80%). |
| .gitignore | Ignores generated junit.xml. |
| .github/workflows/coverage.yml | Generates JUnit XML output and uploads coverage/test results to Codecov. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| comment: | ||
| layout: "diff, files, condensed_footer" | ||
| hide_project_coverage: true # set to true | ||
| require_changes: "coverage_drop AND uncovered_patch" |
Comment on lines
+49
to
+52
| uses: codecov/codecov-action@v7 | ||
| with: | ||
| token: ${{ secrets.CODECOV_TOKEN }} | ||
| report_type: test_results |
Comment on lines
+24
to
+28
| In order to maintain a certain standard regarding code quality, this repository CI will run various tools against expectations: | ||
| - `isort` will be used to check for proper imports sorting, and the CI will fail if the checks fail | ||
| - `black` will be used to check for proper code formatting, and the CI will fail if the checks fail | ||
| - `flake8` will be used to check for proper code styling, and the CI will fail if the checks fail | ||
| - `pytest` will be used to run various levels of testing, and the CI will fail if the tests fail |
| - `black` will be used to check for proper code formatting, and the CI will fail if the checks fail | ||
| - `flake8` will be used to check for proper code styling, and the CI will fail if the checks fail | ||
| - `pytest` will be used to run various levels of testing, and the CI will fail if the tests fail | ||
| - `coverage` with `codecov` will be used to check for proper code coverage, and the CI will fail if the level is below 80% for the current diff (a warning will be emitted if the level falls below 80% for the overall project) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
junit.xmlCONTRIBUTING.mdTesting Instructions
Related issues
Checklist