Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
codecov:
token: uuid # Your private repository token
url: "http" # for Codecov Enterprise customers
slug: "owner/repo" # for Codecov Enterprise customers
branch: master # override the default branch
bot: username # set user whom will be the consumer of oauth requests
ci: # Custom CI domains if Codecov does not identify them automatically
- ci.domain.com
- !provider # ignore these providers when checking if CI passed
# ex. You may test on Travis, Circle, and AppVeyor, but only need
# to check if Travis passes. Therefore add: !circle and !appveyor
notify: # ADVANCED USE ONLY
after_n_builds: null # number of expected builds to recieve before sending notifications
# after: check ci status unless disabled via require_ci_to_pass
require_ci_to_pass: yes # yes: will delay sending notifications until all ci is finished
# no: will send notifications without checking ci status and wait till "after_n_builds" are uploaded
countdown: null # number of seconds to wait before first ci build check
delay: null # number of seconds to wait between ci build checks
coverage:
precision: 2 # 2 = xx.xx%, 0 = xx%
round: down|up|nearest # default down
range: 50...60 # default 70...90. red...green
notify:
irc:
default:
server: "chat.freenode.net"|encrypted
branches: null # all branches by default
threshold: 1%
message: "Coverage {{changed}} for {{owner}}/{{repo}}" # customize the message
flags: null
paths: null
slack:
default:
url: "http"|encrypted
threshold: 1%
branches: null # all branches by default
message: "Coverage {{changed}} for {{owner}}/{{repo}}" # customize the message
attachments: "sunburst, diff"
only_pulls: false
flags: null
paths: null
email:
default:
to:
- example@domain.com
- &author
threshold: 1%
only_pulls: false
layout: header, diff, trends
flags: null
paths: null
hipchat:
default:
url: "http"|encrypted
room: name|id
threshold: 1%
token: encrypted
branches: null # all branches by default
notify: false # if the hipchat message is silent or loud (default false)
message: "Coverage {{changed}} for {{owner}}/{{repo}}" # customize the message
flags: null
paths: null
gitter:
url: "http"|encrypted
threshold: 1%
branches: null # all branches by default
message: "Coverage {{changed}} for {{owner}}/{{repo}}" # customize the message
webhooks:
_name_:
url: "http"|encrypted
threshold: 1%
branches: null # all branches by default
status:
project:
default:
against: parent
target: auto
threshold: 1%
branches:
- master
if_no_uploads: error
if_not_found: success
if_ci_failed: error
only_pulls: false
flags:
- integration
paths:
- folder
patch:
default:
against: parent
target: 80%
branches: null
if_no_uploads: success
if_not_found: success
if_ci_failed: error
only_pulls: false
flags:
- integration
paths:
- folder
changes:
default:
against: parent
branches: null
if_no_uploads: error
if_not_found: success
if_ci_failed: error
only_pulls: false
flags:
- integration
paths:
- folder
flags:
integration:
branches:
- master
ignore:
- app/ui
ignore: # files and folders for processing
- tests/*
fixes:
- "old_path::new_path"
comment:
layout: header, diff, trends, uncovered
branches: *
behavior: default # defualt = posts once then update, posts new if delete
# once = post once then updates
# new = delete old, post new
# spammy = post new
# This file represents the default values when a customer has not filled them out
coverage:
precision: 2
round: down
range: "70...100"
notify:
require_ci_to_pass: yes
status:
project: yes
patch: yes
changes: yes
comment:
layout: "header, diff, changes"
behavior: default
@jessesnyder

This comment has been minimized.

Copy link

jessesnyder commented Aug 8, 2018

Your gist is the most helpful artifact I've found for understanding .codecov.yml. Does a fully-annotated version with all the options shown exist anywhere?

@liaogz82

This comment has been minimized.

Copy link

liaogz82 commented Oct 14, 2018

Can codecov fails a build if it falls below a certain level?

@sbhushan87

This comment has been minimized.

Copy link

sbhushan87 commented Dec 12, 2018

This gist is helpful. thanks. I want to customize notification message to include commit author, can you please let me know attribute name. Also when i receive message over my slack channel, it is not html encoded, it just throwing raw text.

@deeTEEcee

This comment has been minimized.

Copy link

deeTEEcee commented Jul 26, 2019

Codecov UI and docs are so fail that im gonna reconsider my options. At the minimal, i should be able to click a link and see the coverage but instead, here's what happens. I'm using CircleCI and the link provided by codecov upon uploading leads you to an empty diff page while their PR comment link sends you to other galaxies so you just have to click around and figure it out.

@hootener

This comment has been minimized.

Copy link

hootener commented Jan 10, 2020

The full yaml specification is now in codecov's documentation https://docs.codecov.io/docs/codecovyml-reference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.