GitHub Action
Codecov
v4 of the Codecov GitHub Action will use the Codecov CLI to upload coverage reports to Codecov.
Breaking Changes
- Tokenless uploading is unsupported. However, PRs made from forks to the upstream public repos will support tokenless (e.g. contributors to OS projects do not need the upstream repo's Codecov token)
- Various arguments to the Action have been removed
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 (@v4 is recommended) as a step within your workflow.yml file.
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).
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@master
- uses: codecov/codecov-action@v4
with:
fail_ci_if_error: true # optional (default = false)
files: ./coverage1.xml,./coverage2.xml # optional
flags: unittests # optional
name: codecov-umbrella # optional
token: ${{ secrets.CODECOV_TOKEN }} # required
verbose: true # optional (default = false)The Codecov token can also be passed in via environment variables:
steps:
- uses: actions/checkout@master
- uses: codecov/codecov-action@v4
with:
fail_ci_if_error: true # optional (default = false)
files: ./coverage1.xml,./coverage2.xml # optional
flags: unittests # optional
name: codecov-umbrella # optional
verbose: true # optional (default = false)
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}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.
Codecov's Action supports inputs from the user. 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 |
move_coverage_to_trash |
Move discovered coverage reports to the trash | 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 |
dry_run |
Don't upload files to Codecov | 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 |
files |
Comma-separated paths to the coverage report(s). Negated paths are supported by starting with ! |
Optional |
flags |
Flag the upload to group coverage metrics (unittests, uitests, etc.). Multiple flags are separated by a comma (ui,chrome) | Optional |
full_report |
Specify the path of a full Codecov report to re-upload | Optional |
functionalities |
Toggle functionalities | Optional |
-- network |
Disable uploading the file network | Optional |
-- fixes |
Enable file fixes to ignore common lines from coverage | Optional |
-- search |
Disable searching for coverage files | Optional |
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 |
gcov_executable |
gcov executable to run. Defaults to gcov. | Optional |
name |
Custom defined name for the upload | Optional |
network_filter |
Specify a filter on the files listed in the network section of the Codecov report. Useful for upload-specific path fixing | Optional |
network_prefix |
Specify a prefix on files listed in the network section of the Codecov report. Useful to help resolve path fixing | Optional |
os |
Specify the OS (linux, macos, windows, alpine) | 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 |
root_dir |
Used when not in git/hg project to identify project root directory | Optional |
directory |
Directory to search for coverage reports. | Optional |
slug |
Specify the slug manually (Enterprise use) | Optional |
swift |
Run with swift coverage support | Optional |
-- swift_project |
Specify the swift project to speed up coverage conversion | Optional |
upstream_proxy |
The upstream http proxy server to connect through | 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 |
xtra_args |
Add additional uploader args that may be missing in the Action | Optional |
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.10'
steps:
- uses: actions/checkout@master
- name: Setup Python
uses: actions/setup-python@master
with:
python-version: 3.10
- 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@v4
with:
directory: ./coverage/reports/
env_vars: OS,PYTHON
fail_ci_if_error: true
files: ./coverage1.xml,./coverage2.xml,!./cache
flags: unittests
name: codecov-umbrella
token: ${{ secrets.CODECOV_TOKEN }}
verbose: trueContributions are welcome! Check out the Contribution Guide.
The code in this project is released under the MIT License.
