[skip changelog] Enable Codecov reports on pull requests #1783
Conversation
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
This reverts commit 5c9eee3. Codecov will now automatically comment on pull requests to provide a report of the code coverage impact that would result from the proposed changes. These comments are valuable for several reasons: - Brings test deficiencies to the contributor's attention - Encourages contributors to improve PRs that originally had insufficient test coverage for the added code - Facilitates the review process for the maintainers - Increases awareness of code coverage trends in the project (the Codecov website is great for this, but likely rarely visited)
per1234
added
type: enhancement
…decov configuration paths For the sake of efficiency, the "Test Go" GitHub Actions workflow is configured to run only when relevant files are modified. Since the workflow uploads code coverage data to Codecov, the Codecov configuration file is one of these files. The standard filename for the Codecov configuration file is codecov.yml, and the workflow's path filter was configured for that filename. It turns out an alternative filename is also recognized: .codecov.yml, which is used by this project. Two subfolders are also supported in addition to the root of the repository as locations for the configuration file. The workflow's paths filter was not configured for the alternative filename and locations, meaning the workflow would not be triggered on change to the Codecov configuration in projects that use the alternative configuration file name or locations. The workflow's paths filter is hereby configured to recognize changes to any valid Codecov configuration file.
umbynos
approved these changes
Jun 27, 2022
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Infrastructure enhancement
What is the current behavior?
Code coverage is an important metric of quality, efficiency, and sustainability of the development and maintenance of a software project.
Although it is commendable that an above average coverage level has been achieved in this project, the current level is still not sufficient.
No meaningful attention is given to the overall coverage level and impact of each specific proposal on coverage.
What is the new behavior?
Codecov will now automatically comment on relevant pull requests to provide a report of the code coverage impact that would result from the proposed changes:
https://docs.codecov.com/docs/pull-request-comments
These comments are valuable for several reasons:
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.
Other information
The "Test Go" workflow was updated to support the alternative Codecov configuration filename used by this project.