There are two primary locations for the Codecov Yaml. The Team Yaml and the Repository Yaml. Each play an important role in how to configure Codecov.
Below is the default configuration for all projects in Codecov. You may override any of these configuration in your own Team/Repository Yaml.
codecov notify require_ci_to_passyes coverage precision2 rounddown range"70...100" status projectyes patchyes changesno parsers gcov branch_detection conditionalyes loopyes methodno macrono comment layout"header, diff" behaviordefault require_changesno
Codecov provides a user interface to adjust a "team yaml" which is overrides the defaults set by Codecov and is applied to all repositories in the team. Only team admins can adjustment the team yaml in Codecov. All changes are stored in history.
The team yaml (seen in the black box above) can be found in your account center.
Each repository may have their own, unique, Codecov Yaml. The contents of the Repository Yaml are stored in a file, checked into
.codecov.yml in the project root or any subdirectory
All configuration in the Repository Yaml will override the Team Yaml. The Team Yaml is not replaced, but updated with the Repository Yaml.
# Team Yaml coverage rounddown precision5 # Repository Yaml coverage roundup range0..10 # Used in Codecov after updating coverage roundup range0..10 precision5
Validate your repository yaml by posting the content to Codecov for analyzation.
curl --data-binary @codecov.yml https://codecov.io/validate
Codecov will use the default branch for your repository as the "master" copy of the repositories Codecov Yaml. The default branch, if not otherwise stated, is the
master branch. You can change the Codecov default branch in your Yaml.
The default branch is used for:
- Which branch to cache the repository yaml for UI changes
- Which branch is the first branch on the repository dashboard in Codecov
By default Codecov will always use the current yaml on the branch being tested. If you would like to restrict changes to the yaml and always use the yaml on a specific branch you may declare the branch like this:
codecov: strict_yaml_branch: master # only use the latest copy on master branch
Yes you can name the file either
.codecov.yml. The file can be placed anywhere in your repository.
The Codecov Yaml file is the single-point of configuration and gives developers a transparent and version controlled file to adjust all Codecov settings.
Nope. Review our default yaml which all projects use. However, if you need to customize your project in Codecov or add new notifications then the yaml is required.