The Codecov pull request comment is a highly detailed overview of a pull request. It provides details on the coverage changes in the pull request that help with speeding up code review, and ensuring that pull requests are well tested. The comment is customizable to fit your desired needs.
It is important to understand what
absolute <relative> (impact) represents. Learn all about the Codecov Delta.
comment layout"reach, diff, flags, files" behaviordefault require_changesfalse # if true: only post the comment if coverage changes require_baseno # [yes :: must have a base report to post] require_headyes # [yes :: must have a head report to post] branchesnull
Customize your comment layout by choosing the order and types of components to include. Below is an example of a layout for
reach, diff, flags, files.
- Reach is a coverage graph embedded into the comment.
- Learn more here: Graphs: Reach.
- Diff is the Coverage Diff of the pull request.
- Learn more here: Coverage Diff.
- Flags are a list of user defined Flags, and the impact on their coverage
- Learn more about setting up Flags.
- Files are a list of files that are impacted by the pull request (coverage changes, file is new or removed).
Choose the way Codecov submits comments in your pull requests.
default: update, if exists. Otherwise post new.
once: update, if exists. Otherwise post new. Skip if deleted.
new: delete old and post new.
spammy: post new (do not delete old comments).
Emails will be submitted to all subscribers of the pull request only when posting a new comment. There is no way to disable email notifications. This is a limitation of the [[Service Providers]].
To disable the comment, simply set the comment to false in your
codecov.yml, as shown below.
You can do this in your Team Yaml, to take effect on all your repositories.
You may desire to change when the comment is posted, if any changes are discovered in coverage.
Comments will now only post when coverage changes. Furthermore, if a comment already exists, and a newer commit results in no coverage change for the entire pull, the comment will be deleted.
It is important to learn about the Codecov Delta syntax to fully understand pull request comments.