actions/codecov-action
1
0
Fork 0
mirror of https://github.com/codecov/codecov-action.git synced 2025-12-23 20:27:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

add name documentation info

Browse Source
This commit is contained in:
“ibrahim0814”
2019-08-07 18:30:01 -07:00
parent 77578a4d61
commit 6625b1305d
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -10,11 +10,12 @@ Inside your `.github/workflows/workflow.yml` file:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: actions/codecov-action@v0.4 - uses: actions/codecov-action@v1
with: with:
token: ${{secrets.CODECOV_TOKEN}} #for private repos token: ${{secrets.CODECOV_TOKEN}} #for private repos
file: ./coverage.xml #optional file: ./coverage.xml #optional
flags: unittests #optional flags: unittests #optional
name: codecov-1 #optional
``` ```
>**Note**: This assumes that you've set your Codecov token inside settings > secrets as `CODECOV_TOKEN`. If not, you can get an upload token for your specific repo on codecov.io. A token is *not* required for public repositories. >**Note**: This assumes that you've set your Codecov token inside settings > secrets as `CODECOV_TOKEN`. If not, you can get an upload token for your specific repo on codecov.io. A token is *not* required for public repositories.
@@ -41,11 +42,12 @@ jobs:
pytest --cov=./ --cov-report=xml pytest --cov=./ --cov-report=xml
- name: Upload coverage to Codecov - name: Upload coverage to Codecov
uses: codecov/codecov-action@v0.4 uses: codecov/codecov-action@v1
with: with:
token: ${{secrets.CODECOV_TOKEN}} token: ${{secrets.CODECOV_TOKEN}}
file: ./coverage.xml file: ./coverage.xml
flags: unittests flags: unittests
name: codecov-1
``` ```
## Arguments ## Arguments
@@ -54,7 +56,8 @@ jobs:
| :---: | :---: | | :---: | :---: |
| `token` | Used to authorize coverage report uploads | | `token` | Used to authorize coverage report uploads |
| `file` | Location of the coverage report | | `file` | Location of the coverage report |
| `flags` | Flag upload to group coverage metrics | | `flags` | Flag upload under a certain group name |
| `name` | Custom defined name for the upload |
## License ## License