actions/codecov-action
3
0
Fork 0
mirror of https://github.com/codecov/codecov-action.git synced 2026-02-09 20:47:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Explain requirements for Codecov YAML in README

Browse source
This commit is contained in:
Paul Razvan Berg 2023-02-07 11:47:12 +02:00
parent e0fbd592d3
commit d962c8fc94
No known key found for this signature in database
GPG key ID: BCC366159BD63828
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -44,6 +44,14 @@ steps:
```
>**Note**: This assumes that you've set your Codecov token inside *Settings > Secrets* as `CODECOV_TOKEN`. If not, you can [get an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) for your specific repo on [codecov.io](https://www.codecov.io). Keep in mind that secrets are *not* available to forks of repositories.
### Codecov YAML
To ensure that your Codecov YAML configuration is selected by this GitHub Action, there are a few things you need to do:
1. Name your config `codecov.yaml`. The name that starts with the dot (`.codecov.yml`) is not supported.
2. Keep the config file at the root of your repo.
3. (For GitHub organizations) Set up the [Codecov GitHub app](https://github.com/apps/codecov).
## 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: