Fix flaky codecov reports #168
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
Currently implementation of codecov reports sometimes attaches the analysis to main branch instead of the triggering PR. The root cause of the issue is a bug in Github which does not always populate `github.event.workflow_run.pull_requests[0]`. When it is populated, the current implementation works. When it is missing, `override_commit` and `override_pr` params to `codecov-action` become unset. More information available at https://github.com/orgs/community/discussions/25220 The workaround is to store both commit SHA and PR number in the original workflow since those are available there.
mgeisler
approved these changes
Feb 2, 2024
There was a problem hiding this comment.
Sure, I can see how this can be made to work.
Another option (a much simpler option) would be to only trigger the workflow on the main branch after a merge.
The prr-PR reports are not super important for me — they can be a little silly and make people focus on a 0.3% drop in coverage when they should really be focusing on writing maintainable code and tests 🙂
|
Yeah, the other option is much simpler. I think having an ability to do this is good though. If we decide to use PR report we now have it. If we don't need it, filtering can be done using |
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.
Currently implementation of codecov reports sometimes attaches the analysis to main branch instead of the triggering PR. The root cause of the issue is a bug in Github which does not always populate
github.event.workflow_run.pull_requests[0]. When it is populated, the current implementation works. When it is missing,override_commitandoverride_prparams tocodecov-actionbecome unset.More information available at
https://github.com/orgs/community/discussions/25220
The workaround is to store both commit SHA and PR number in the original workflow since those are available there.
Fixes #148