Codecov GitHub Action

Easily upload coverage reports to Codecov from GitHub Actions

The latest release of this Action adds support for tokenless uploads from GitHub Actions!

⚠️ Deprecration of v1

As of February 1, 2022, v1 has been fully sunset and no longer functions

Due to the deprecation of the underlying bash uploader, the Codecov GitHub Action has released v2 which will use the new uploader. You can learn more about our deprecation plan and the new uploader on our blog.

We will be restricting any updates to the v1 Action to security updates and hotfixes.

Migration from v1 to v2

The v2 uploader has a few breaking changes for users

• Multiple fields have not been transferred from the bash uploader or have been deprecated. Notably many of the functionalities and gcov_ arguments have been removed. Please check the documentation below for the full list.

Usage

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

If you have a private repository, this Action also requires you to provide an upload token from codecov.io (tip: in order to avoid exposing your token, store it as a secret). Optionally, you can choose to include up to four additional inputs to customize the upload context. For public repositories, no token is needed

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

steps:
- uses: actions/checkout@master
- uses: codecov/codecov-action@v2
  with:
    token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
    files: ./coverage1.xml,./coverage2.xml # optional
    flags: unittests # optional
    name: codecov-umbrella # optional
    fail_ci_if_error: true # optional (default = false)
    verbose: true # optional (default = false)

Note: This assumes that you've set your Codecov token inside Settings > Secrets as CODECOV_TOKEN. If not, you can get an upload token for your specific repo on codecov.io. Keep in mind that secrets are not available to forks of repositories.

Arguments

Codecov's Action currently supports five inputs from the user: token, file, flags,name, and fail_ci_if_error. These inputs, along with their descriptions and usage contexts, are listed in the table below:

Input	Description	Usage
token	Used to authorize coverage report uploads	Required for private repos
files	Comma-separated paths to the coverage report(s)	Optional
directory	Directory to search for coverage reports.	Optional
dry_run	Don't upload files to Codecov	Optional
flags	Flag the upload to group coverage metrics (unittests, uitests, etc.). Multiple flags are separated by a comma (ui,chrome)	Optional
commit_parent	The commit SHA of the parent for which you are uploading coverage. If not present, the parent will be determined using the API of your repository provider. When using the repository provider's API, the parent is determined via finding the closest ancestor to the commit.	Optional
env_vars	Environment variables to tag the upload with. Multiple env variables can be separated with commas (e.g. OS,PYTHON)	Optional
fail_ci_if_error	Specify if CI pipeline should fail when Codecov runs into errors during upload. Defaults to false	Optional
functionalities	Toggle functionalities	Optional
	network Disable uploading the file network
gcov	Run with gcov support	Optional
gcov_args	Extra arguments to pass to gcov	Optional
gcov_ignore	Paths to ignore during gcov gathering	Optional
gcov_include	Paths to include during gcov gathering	Optional
move_coverage_to_trash	Move discovered coverage reports to the trash	Optional
name	Custom defined name for the upload	Optional
override_branch	Specify the branch name	Optional
override_build	Specify the build number	Optional
override_commit	Specify the commit SHA	Optional
override_pr	Specify the pull request number	Optional
override_tag	Specify the git tag	Optional
path_to_write_report	Write upload file to path before uploading	Optional
root_dir	Used when not in git/hg project to identify project root directory	Optional
slug	Specify the slug manually (Enterprise use)	Optional
url	Change the upload host (Enterprise use)	Optional
verbose	Specify whether the Codecov output should be verbose	Optional
version	Specify which version of the Codecov Uploader should be used. Defaults to latest	Optional
working-directory	Directory in which to execute codecov.sh	Optional
xcode	Run with xcode support	Optional
xcode_archive_path	Specify the xcode archive path. Likely specified as the -resultBundlePath and should end in .xcresult	Optional

Example workflow.yml with Codecov Action

name: Example workflow for Codecov
on: [push]
jobs:
  run:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    env:
      OS: ${{ matrix.os }}
      PYTHON: '3.7'
    steps:
    - uses: actions/checkout@master
    - name: Setup Python
      uses: actions/setup-python@master
      with:
        python-version: 3.7
    - name: Generate coverage report
      run: |
        pip install pytest
        pip install pytest-cov
        pytest --cov=./ --cov-report=xml
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v2
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        directory: ./coverage/reports/
        env_vars: OS,PYTHON
        fail_ci_if_error: true
        files: ./coverage1.xml,./coverage2.xml
        flags: unittests
        name: codecov-umbrella
        path_to_write_report: ./coverage/codecov_report.txt
        verbose: true

Contributing

Contributions are welcome! Check out the Contribution Guide.

License

The code in this project is released under the MIT License.