Skip to content
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

Disable codecov patch updates #109

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

haydentherapper
Copy link
Contributor

This creates a decent amount of noisy comments on PRs. We have this off for other repos and codecov still works fine, generating reports for coverage for the PR.

Summary

Release Note

Documentation

This creates a decent amount of noisy comments on PRs. We have this off for other repos and codecov still works fine, generating reports for coverage for the PR.

Signed-off-by: Hayden B <haydentherapper@users.noreply.github.com>
@haydentherapper haydentherapper requested review from a team as code owners March 17, 2025 22:44
@jku
Copy link
Member

jku commented Mar 18, 2025

The codecov annotations are indeed annoying.

Can you describe what this change does in practice: Does it remove the code annotations or the PR comment, or both?

Examples in sigstore org may not be a good indication of best practices since it seems clear that no one actually looks at codecov coverage (based on the finding that baseline coverage is not being reported in any of the projects).

@jku
Copy link
Member

jku commented Mar 18, 2025

Can you describe what this change does in practice: Does it remove the code annotations or the PR comment, or both?

For context I'm asking this since if this removes the PR comment then I don't understand why we use codecov. If it doesn't provide the info in the PR what's the advantage over running go tool cover locally when I want to check coverage?

@haydentherapper
Copy link
Contributor Author

I was under the impression that it would drop the codecov/patch comments left throughout the PR, but still compute overall coverage and provide percent changes, like in sigstore/rekor#2413.

Copy link
Member

@jku jku left a comment

Choose a reason for hiding this comment

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

I was under the impression that it would drop the codecov/patch comments left throughout the PR, but still compute overall coverage and provide percent changes, like in sigstore/rekor#2413.

This sounds good to me 👍

@loosebazooka
Copy link
Member

I wonder if we should disable annotations like this instead: https://docs.codecov.com/docs/github-checks#disabling-github-checks-patch-annotations-via-yaml ?

I think patch checks might still be useful, but I don't have a good grasp on how they will be surfaced without annotations.

@jku
Copy link
Member

jku commented Mar 20, 2025

Happy to try any setup out -- I don't think I can reliably map the codecov docs to actual GitHub things, they're not to clearest docs ever

@loosebazooka
Copy link
Member

Also apparently you can just use keyboard shortcut a to toggle annotations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants