update readme

This commit is contained in:
Ibrahim Ali
2019-11-20 13:00:29 -08:00
committed by GitHub
parent 3ec2345d08
commit dd2a59ac10

View File

@@ -3,6 +3,8 @@
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1.0.4-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov)
### Easily upload coverage reports to Codecov from GitHub Actions
>The latest release of this Action adds support for macOS and Windows builds!
## 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 four additional inputs to customize the upload context.
@@ -35,7 +37,6 @@ Codecov's Action currently supports five inputs from the user: `token`, `file`,
| `yml` | Path to codecov.yml config file | Optional
### Example `workflow.yml` with Codecov Action
>**Note**: The latest release of this Action adds support for macOS and Windows builds!
```yaml
name: Example workflow for Codecov