Skip to content

Commit 781907b

Browse files
Update README.md
1 parent 93b3dea commit 781907b

File tree

1 file changed

+37
-42
lines changed

1 file changed

+37
-42
lines changed

README.md

+37-42
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# Codecov GitHub Action
22

3-
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v3-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov)
3+
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v4-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov)
44
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action?ref=badge_shield)
55
[![Workflow for Codecov Action](https://github.com/codecov/codecov-action/actions/workflows/main.yml/badge.svg)](https://github.com/codecov/codecov-action/actions/workflows/main.yml)
66
### Easily upload coverage reports to Codecov from GitHub Actions
77

88
## v4 Release
99
`v4` of the Codecov GitHub Action will use the [Codecov CLI](https://github.com/codecov/codecov-cli) to upload coverage reports to Codecov.
1010

11-
Breaking Changes
11+
### Breaking Changes
1212
- 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)
1313
- Various arguments to the Action have been removed
14+
15+
### Dependabot
1416
- For repositories using `Dependabot`, users will need to ensure that it has access to the Codecov token for PRs from Dependabot to upload coverage.
1517

1618
`v3` versions and below will not have access to CLI features (e.g. global upload token, ATS).
@@ -65,47 +67,40 @@ steps:
6567

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

68-
| Input | Description | Usage |
70+
| Input | Description | Required |
6971
| :---: | :---: | :---: |
70-
| `token` | Used to authorize coverage report uploads | *Required |
71-
| `move_coverage_to_trash` | Move discovered coverage reports to the trash | Optional
72-
| `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
73-
| `dry_run` | Don't upload files to Codecov | Optional
74-
| `env_vars` | Environment variables to tag the upload with. Multiple env variables can be separated with commas (e.g. `OS,PYTHON`) | Optional
75-
| `fail_ci_if_error` | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false*** | Optional
76-
| `files` | Comma-separated paths to the coverage report(s). Negated paths are supported by starting with `!` | Optional
77-
| `flags` | Flag the upload to group coverage metrics (unittests, uitests, etc.). Multiple flags are separated by a comma (ui,chrome) | Optional
78-
| `full_report` | Specify the path of a full Codecov report to re-upload | Optional
79-
| `functionalities` | Toggle functionalities | Optional
80-
| -- `network` | Disable uploading the file network | Optional
81-
| -- `fixes` | Enable file fixes to ignore common lines from coverage | Optional
82-
| -- `search` | Disable searching for coverage files | Optional
83-
| `gcov` | Run with gcov support | Optional
84-
| `gcov_args` | Extra arguments to pass to gcov | Optional
85-
| `gcov_ignore` | Paths to ignore during gcov gathering | Optional
86-
| `gcov_include` | Paths to include during gcov gathering | Optional
87-
| `gcov_executable` | gcov executable to run. Defaults to gcov. | Optional
88-
| `name` | Custom defined name for the upload | Optional
89-
| `network_filter` | Specify a filter on the files listed in the network section of the Codecov report. Useful for upload-specific path fixing | Optional
90-
| `network_prefix` | Specify a prefix on files listed in the network section of the Codecov report. Useful to help resolve path fixing | Optional
91-
| `os` | Specify the OS (linux, macos, windows, alpine) | Optional
92-
| `override_branch` | Specify the branch name | Optional
93-
| `override_build` | Specify the build number | Optional
94-
| `override_commit` | Specify the commit SHA | Optional
95-
| `override_pr` | Specify the pull request number | Optional
96-
| `override_tag` | Specify the git tag | Optional
97-
| `root_dir` | Used when not in git/hg project to identify project root directory | Optional
98-
| `directory` | Directory to search for coverage reports. | Optional
99-
| `slug` | Specify the slug manually (Enterprise use) | Optional
100-
| `swift` | Run with swift coverage support | Optional
101-
| -- `swift_project` | Specify the swift project to speed up coverage conversion | Optional
102-
| `upstream_proxy` | The upstream http proxy server to connect through | Optional
103-
| `url` | Change the upload host (Enterprise use) | Optional
104-
| `verbose` | Specify whether the Codecov output should be verbose | Optional
105-
| `version` | Specify which version of the Codecov Uploader should be used. Defaults to `latest` | Optional
106-
| `working-directory` | Directory in which to execute `codecov.sh` | Optional
107-
| `xtra_args` | Add additional uploader args that may be missing in the Action | Optional
108-
72+
| `token` | Repository Codecov token. Used to authorize report uploads | Optional
73+
| `codecov_yml_path` | Specify the path to the Codecov YML | Optional
74+
| `commit_parent` | Override to specify the parent commit SHA | Optional
75+
| `directory` | Directory to search for coverage reports. | Optional
76+
| `disable_search` | Disable search for coverage files. This is helpful when specifying what files you want to upload with the --file option. | Optional
77+
| `disable_file_fixes` | Disable file fixes to ignore common lines from coverage (e.g. blank lines or empty brackets) | Optional
78+
| `dry_run` | Don't upload files to Codecov | Optional
79+
| `env_vars` | Environment variables to tag the upload with (e.g. PYTHON | OS,PYTHON) | Optional
80+
| `exclude` | Folders to exclude from search | Optional
81+
| `fail_ci_if_error` | Specify whether or not CI build should fail if Codecov runs into an error during upload | Optional
82+
| `file` | Path to coverage file to upload | Optional
83+
| `files` | Comma-separated list of files to upload | Optional
84+
| `flags` | Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome) | Optional
85+
| `handle_no_reports_found` | Raise no exceptions when no coverage reports found | Optional
86+
| `job_code` | The job code | Optional
87+
| `name` | User defined upload name. Visible in Codecov UI | Optional
88+
| `os` | Override the assumed OS. Options are linux | macos | windows | . | Optional
89+
| `override_branch` | Specify the branch name | Optional
90+
| `override_build` | Specify the build number | Optional
91+
| `override_build_url` | The URL of the build where this is running | Optional
92+
| `override_commit` | Specify the commit SHA | Optional
93+
| `override_pr` | Specify the pull request number | Optional
94+
| `plugin` | plugins to run. Options: xcode, gcov, pycoverage. The default behavior runs them all. | Optional
95+
| `plugins` | Comma-separated list of plugins for use during upload. | Optional
96+
| `report_code` | The code of the report. If unsure, do not include | Optional
97+
| `root_dir` | Used when not in git/hg project to identify project root directory | Optional
98+
| `slug` | Specify the slug manually (Enterprise use) | Optional
99+
| `url` | Specify the base url to upload (Enterprise use) | Optional
100+
| `use_legacy_upload_endpoint` | Use the legacy upload endpoint | Optional
101+
| `verbose` | Specify whether the Codecov output should be verbose | Optional
102+
| `version` | Specify which version of the Codecov CLI should be used. Defaults to `latest` | Optional
103+
| `working-directory` | Directory in which to execute codecov.sh | Optional
109104

110105
### Example `workflow.yml` with Codecov Action
111106

0 commit comments

Comments
 (0)