Repository files navigation

v5 of the Codecov GitHub Action will use theCodecov Wrapper to encapsulate theCLI. This will help ensure that the Action gets updates quicker.

Thev5 release also coincides with the opt-out feature for tokens for public repositories. In theGlobal Upload Token section of the settings page of an organization in codecov.io, you can set the ability for Codecov to receive a coverage reports from any source. This will allow contributors or other members of a repository to upload without needing access to the Codecov token. For more details seehow to upload without a token.

[!WARNING] >The following arguments have been changed

• file (this has been deprecated in favor offiles)
• plugin (this has been deprecated in favor ofplugins)

The following arguments have been added:

• binary
• gcov_args
• gcov_executable
• gcov_ignore
• gcov_include
• report_type
• skip_validation
• swift_project

You can see their usage in theaction.ymlfile.

v4 of the Codecov GitHub Action will use theCodecov CLI to upload coverage reports to Codecov.

• Tokenless uploading is unsupported. However, PRs made from forks to the upstream public repos will support tokenless (e.g. contributors to OSS projects do not need the upstream repo's Codecov token). For details,see our docs
• Various arguments to the Action have been removed

• For repositories usingDependabot, users will need to ensure that it has access to the Codecov token for PRs from Dependabot to upload coverage. To do this, please add yourCODECOV_TOKEN as a Dependabot Secret. For more information, see"Configuring access to private registries for Dependabot."

v3 versions and below will not have access to CLI features (e.g. global upload token, ATS).

To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (@v5 is recommended) as astep within yourworkflow.yml file.

This Action also requires you toprovide an upload token fromcodecov.io (tip: in order to avoid exposing your token,store it as asecret).

Currently, the Action will identify linux, macos, and windows runners. However, the Action may misidentify other architectures. The OS can be specified as

• alpine
• alpine-arm64
• linux
• linux-arm64
• macos
• windows

Inside your.github/workflows/workflow.yml file:

steps:  -uses:actions/checkout@main  -uses:codecov/codecov-action@v5with:fail_ci_if_error:true# optional (default = false)files:./coverage1.xml,./coverage2.xml# optionalflags:unittests# optionalname:codecov-umbrella# optionaltoken:${{ secrets.CODECOV_TOKEN }}verbose:true# optional (default = false)

The Codecov token can also be passed in via environment variables:

steps:  -uses:actions/checkout@main  -uses:codecov/codecov-action@v5with:fail_ci_if_error:true# optional (default = false)files:./coverage1.xml,./coverage2.xml# optionalflags:unittests# optionalname:codecov-umbrella# optionalverbose:true# optional (default = false)env:CODECOV_TOKEN:${{ secrets.CODECOV_TOKEN }}

As an alternative to Codecov upload tokens, you can choose to use OIDC as your upload authentication method by setting theuse_oidc argument:

-uses:codecov/codecov-action@v5with:use_oidc:true

Any token supplied will be ignored, as Codecov will default to the OIDC token for verification.

Note that the codecov action must have write permission forid-token for this to work:

permissions:id-token:write

This can be set at either the workflow or job level. See GitHub'sdocs for more details.

Codecov's Action supports inputs from the user. These inputs, along with their descriptions and usage contexts, are listed in the table below:

name:Example workflow for Codecovon:[push]jobs:run:runs-on:${{ matrix.os }}strategy:matrix:os:[ubuntu-latest, macos-latest, windows-latest]env:OS:${{ matrix.os }}PYTHON:"3.10"steps:      -uses:actions/checkout@main      -name:Setup Pythonuses:actions/setup-python@mainwith:python-version:"3.10"      -name:Generate coverage reportrun:|          pip install pytest          pip install pytest-cov          pytest --cov=./ --cov-report=xml      -name:Upload coverage to Codecovuses:codecov/codecov-action@v5with:directory:./coverage/reports/env_vars:OS,PYTHONfail_ci_if_error:truefiles:./coverage1.xml,./coverage2.xml,!./cacheflags:unittestsname:codecov-umbrellatoken:${{ secrets.CODECOV_TOKEN }}verbose:true

Contributions are welcome! Check out theContribution Guide.

The code in this project is released under theMIT License.