diff --git a/README.md b/README.md index be0f956..b87a1a6 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # Codecov GitHub Action -[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1.0.6-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov) +[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1-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 + Windows builds and tokenless uploads for public repos! ## 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. 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** +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,11 +18,11 @@ steps: - uses: actions/checkout@master - uses: codecov/codecov-action@v1 with: - token: ${{ secrets.CODECOV_TOKEN }} #required for private repos - file: ./coverage.xml #optional - flags: unittests #optional - name: codecov-umbrella #optional - fail_ci_if_error: true #optional (default = false) + token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos + file: ./coverage.xml # optional + flags: unittests # optional + name: codecov-umbrella # optional + fail_ci_if_error: 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). Keep in mind that secrets are *not* available to forks of repositories. @@ -28,7 +30,7 @@ steps: 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` paramter with the latest release of this action. Please put your custom codecov yaml file at the root of the repo because other locations are no longer supported. +>**Update**: We've removed the `yml` paramter 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 | | :---: | :---: | :---: |