-
Notifications
You must be signed in to change notification settings - Fork 179
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.
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
[CI, Enhancement] Add Codecov support #2222
Merged
Merged
Conversation
This file contains 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
Oops, this won't work because of the secret. Will need to come up with another approach (and especially with the ability to test it) |
I'm going to have to separate it and put it in a workflow_run, may require local testing on my own fork (I hate having to do this again) |
ahuber21
approved these changes
Dec 12, 2024
example PR with it functional: icfaust#7 |
Alexsandruss
approved these changes
Dec 12, 2024
13 tasks
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.
Description
Codecov is a code coverage analysis service which can integrate with the coverage.py result files that are generated by GitHub actions CI. A separate upload github action is created which is triggered by the successful completion of the pull request / push CI. This is separated as a 'workflow_run' event because it needs to access secrets to communicate with codecov and because pull requests run untested code (vulnerability surface in GitHub). The workflow_run uses the main branch, so certain settings of codecov-cli need to be manually supplied about the PR for codecov to properly integrate (the PR number, the commit SHA).
As of now, the default codecov settings are used, so that no CI failures can be generated by codecov. Thus functionality cannot be tested as it is 'workflow_run'. An example run using my fork will be presented to show operation using the code of this PR. Once it is brought into main, comments will be made by codecov, and it will be added to github checks to show the delta in code coverage as well as the overall percent. Accessing codecov will provide a GUI for seeing the changes in the code.
A follow up PR integrating codecov into azure pipelines will be necessary. This is because of the slow iteration cycle of the azure pipelines CI (as I will only be able to test via PRs, not on my own fork).
PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.
You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).
Checklist to comply with before moving PR from draft:
PR completeness and readability
Testing