mirror of
https://github.com/codecov/codecov-action.git
synced 2025-12-23 20:27:02 +08:00
add name documentation info
This commit is contained in:
@@ -10,11 +10,12 @@ Inside your `.github/workflows/workflow.yml` file:
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- uses: actions/codecov-action@v0.4
|
||||
- uses: actions/codecov-action@v1
|
||||
with:
|
||||
token: ${{secrets.CODECOV_TOKEN}} #for private repos
|
||||
file: ./coverage.xml #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.
|
||||
|
||||
@@ -41,11 +42,12 @@ jobs:
|
||||
pytest --cov=./ --cov-report=xml
|
||||
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v0.4
|
||||
uses: codecov/codecov-action@v1
|
||||
with:
|
||||
token: ${{secrets.CODECOV_TOKEN}}
|
||||
file: ./coverage.xml
|
||||
flags: unittests
|
||||
name: codecov-1
|
||||
```
|
||||
|
||||
## Arguments
|
||||
@@ -54,7 +56,8 @@ jobs:
|
||||
| :---: | :---: |
|
||||
| `token` | Used to authorize coverage report uploads |
|
||||
| `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
|
||||
|
||||
Reference in New Issue
Block a user