### Easily upload coverage reports to Codecov from GitHub Actions
>The latest release of this Action adds support for macOS and Windows builds!
>The latest release of this Action adds support for tokenless uploads from GitHub Actions!
## Usage
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number as a `step` within your `workflow.yml` file. This Action also requires you to [provide an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) from [codecov.io](https://www.codecov.io) (tip: in order to avoid exposing your token, store it as a `secret`). Optionally, you can choose to include up to five additional inputs to customize the upload context.
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (`@v1` 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](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) from [codecov.io](https://www.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:
@@ -16,27 +19,34 @@ steps:
- uses:actions/checkout@master
- uses:codecov/codecov-action@v1
with:
token:${{ secrets.CODECOV_TOKEN }}#required
file:./coverage.xml#optional
flags:unittests#optional
name:codecov-umbrella#optional
yml:./codecov.yml#optional
fail_ci_if_error:true#optional (default = false)
token:${{ secrets.CODECOV_TOKEN }}# not required for public repos
file:./coverage.xml#optional
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](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).
>**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.
## Arguments
Codecov's Action currently supports five inputs from the user: `token`, `file`, `flags`,`name`,`yml`, and `fail_ci_if_error`. These inputs, along with their descriptions and usage contexts, are listed in the table below:
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:
>**Update**: We've removed the `yml` parameter with the latest release of this action. Please put your custom codecov yaml file at the root of the repo because other locations will no longer be supported in the future.
| Input | Description | Usage |
| :---: | :---: | :---: |
| `token` | Used to authorize coverage report uploads | *Required* |
| `token` | Used to authorize coverage report uploads | *Required for private repos* |
| `file` | Path to the coverage report(s) | Optional
| `flags` | Flag the upload to group coverage metrics (unittests, uitests, etc.) | Optional
| `files` | Comma-separated paths to the coverage report(s) | Optional
| `directory` | Directory to search for coverage reports. | Optional
| `flags` | Flag the upload to group coverage metrics (unittests, uitests, etc.). Multiple flags are separated by a comma (ui,chrome) | Optional
| `env_vars` | Environment variables to tag the upload with. Multiple env variables can be separated with commas (e.g. `OS,PYTHON`) | Optional
| `name` | Custom defined name for the upload | Optional
| `yml` | Path to codecov.yml config file | Optional
| `fail_ci_if_error` | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false***. | Optional
| `fail_ci_if_error` | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false*** | Optional
| `path_to_write_report` | Write upload file to path before uploading | Optional
| `verbose` | Specify whether the Codecov output should be verbose | Optional
### Example `workflow.yml` with Codecov Action
@@ -47,11 +57,14 @@ jobs:
run:
runs-on:${{ matrix.os }}
strategy:
matrix:
matrix:
os:[ubuntu-latest, macos-latest, windows-latest]
env:
OS:${{ matrix.os }}
PYTHON:'3.7'
steps:
- uses:actions/checkout@master
- name:Setup Python
- name:Setup Python
uses:actions/setup-python@master
with:
python-version:3.7
@@ -60,20 +73,27 @@ jobs:
pip install pytest
pip install pytest-cov
pytest --cov=./ --cov-report=xml
- name:Upload coverage to Codecov
- name:Upload coverage to Codecov
uses:codecov/codecov-action@v1
with:
token:${{ secrets.CODECOV_TOKEN }}
file:./coverage.xml
files:./coverage1.xml,./coverage2.xml
directory:./coverage/reports/
flags:unittests
env_vars:OS,PYTHON
name:codecov-umbrella
yml:./codecov.yml
fail_ci_if_error:true
path_to_write_report:./coverage/codecov_report.gz
verbose:true
```
## Contributing
Contributions are welcome! Check out the [Contribution Guide](CONTRIBUTING.md).
## License
## License
The code in this project is released under the [MIT License](LICENSE).
//This function is tested and part of it is uncovered
uncovered_if=(a=true)=>{
if(a==true){
returnfalse
}else{
returntrue
}
}
//This function will be fully covered
fully_covered=()=>{
returntrue
}
//This function will not be tested by unit tests
uncovered=()=>{
returntrue
}
}
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Tom Hu