Codecov configuration files

codecov.yml files

Type object
File match **/.github/.codecov.yml **/.github/codecov.yml **/dev/.codecov.yml **/dev/codecov.yml .codecov.yml codecov.yml
Schema URL https://catalog.lintel.tools/schemas/github/codecov-configuration-files/latest.json
Source https://www.schemastore.org/codecov.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Schema for codecov.yml files.

Properties

codecov object

See https://docs.codecov.io/docs/codecov-yaml for details

14 nested properties
url string
slug string
bot string

Team bot. See https://docs.codecov.io/docs/team-bot for details

branch string
ci string[]

Detecting CI services. See https://docs.codecov.io/docs/detecting-ci-services for details.

assume_all_flags boolean
strict_yaml_branch string
max_report_age string | integer | boolean
disable_default_path_fixes boolean
require_ci_to_pass boolean
allow_pseudo_compare boolean
archive object
1 nested properties
uploads boolean
notify object
4 nested properties
after_n_builds integer
countdown integer
delay integer
wait_for_ci boolean
ui object
5 nested properties
hide_density boolean | array
hide_complexity boolean | array
hide_contextual boolean
hide_sunburst boolean
hide_search boolean
coverage object

Coverage configuration. See https://docs.codecov.io/docs/coverage-configuration for details.

5 nested properties
precision integer
min=0max=5
round enum
Values: "down" "up" "nearest"
range string
notify object

Notifications. See https://docs.codecov.io/docs/notifications for details.

6 nested properties
irc object
12 nested properties
url string
branches string
threshold string
message string
flags string
base enum
Values: "parent" "pr" "auto"
only_pulls boolean
paths string[]
channel string
password string
nickserv_password string
notice boolean
slack object

Slack. See https://docs.codecov.io/docs/notifications#section-slack for details.

9 nested properties
url string
branches string
threshold string
message string
flags string
base enum
Values: "parent" "pr" "auto"
only_pulls boolean
paths string[]
attachments enum
gitter object

Gitter. See https://docs.codecov.io/docs/notifications#section-gitter for details.

8 nested properties
url string
branches string
threshold string
message string
flags string
base enum
Values: "parent" "pr" "auto"
only_pulls boolean
paths string[]
hipchat object

Hipchat. See https://docs.codecov.io/docs/notifications#section-hipchat for details.

10 nested properties
url string
branches string
threshold string
message string
flags string
base enum
Values: "parent" "pr" "auto"
only_pulls boolean
paths string[]
card boolean
notify boolean
webhook object
8 nested properties
url string
branches string
threshold string
message string
flags string
base enum
Values: "parent" "pr" "auto"
only_pulls boolean
paths string[]
email object
10 nested properties
url string
branches string
threshold string
message string
flags string
base enum
Values: "parent" "pr" "auto"
only_pulls boolean
paths string[]
layout enum
+to string[]
status boolean | object

Commit status. See https://docs.codecov.io/docs/commit-status for details.

4 nested properties
default_rules object
project Record<string, default>
1 nested properties
default
patch object | string | boolean
changes
11 nested properties
target string | number
Default: "auto"
pattern=^(([0-9]+\.?[0-9]*|\.[0-9]+)%?|auto)$
threshold string
Default: "0%"
pattern=^([0-9]+\.?[0-9]*|\.[0-9]+)%?$
base string
Default: "auto"
flags array
Default:
[]
paths array | string
Default:
[]
branches array
Default:
[]
if_not_found string
Default: "success"
Values: "failure" "success"
informational boolean
Default: false
only_pulls boolean
Default: false
if_ci_failed string
Values: "error" "success"
flag_coverage_not_uploaded_behavior string
Values: "include" "exclude" "pass"
ignore string[]

Ignoring paths. see https://docs.codecov.io/docs/ignoring-paths for details.

fixes string[]

Fixing paths. See https://docs.codecov.io/docs/fixing-paths for details.

flags flag[] | object

Flags. See https://docs.codecov.io/docs/flags for details.

comment object | const: false

Pull request comments. See https://docs.codecov.io/docs/pull-request-comments for details.

github_checks object | boolean | string

GitHub Checks. See https://docs.codecov.com/docs/github-checks for details.

Definitions

default
target string | number
Default: "auto"
pattern=^(([0-9]+\.?[0-9]*|\.[0-9]+)%?|auto)$
threshold string
Default: "0%"
pattern=^([0-9]+\.?[0-9]*|\.[0-9]+)%?$
base string
Default: "auto"
flags array
Default:
[]
paths array | string
Default:
[]
branches array
Default:
[]
if_not_found string
Default: "success"
Values: "failure" "success"
informational boolean
Default: false
only_pulls boolean
Default: false
if_ci_failed string
Values: "error" "success"
flag_coverage_not_uploaded_behavior string
Values: "include" "exclude" "pass"
flag object
joined boolean
required boolean
ignore string[]
paths string[]
assume boolean | array
layout enum
notification object
url string
branches string
threshold string
message string
flags string
base enum
Values: "parent" "pr" "auto"
only_pulls boolean
paths string[]