https://github.com/iansu/codecov-action-node
https://github.com/iansu/codecov-action-node
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/iansu/codecov-action-node
- Owner: iansu
- License: mit
- Created: 2019-09-25T17:54:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-18T19:16:12.000Z (over 2 years ago)
- Last Synced: 2025-04-04T03:02:44.512Z (about 1 month ago)
- Language: JavaScript
- Size: 3.14 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Codecov Action Node
GitHub Action that uploads coverage reports to [codecov.io](https://www.codecov.io/)
## Usage
Add a step to your GitHub Actions workflow YAML that uses this action:
```yml
steps:
- uses: actions/checkout@master
- uses: iansu/codecov-action-node@v1
with:
token: ${{secrets.CODECOV_TOKEN}} #required
file: ./coverage.xml #optional
flags: unittests #optional
name: codecov-umbrella #optional
```
> Note: This assumes that you've set your Codecov token inside Settings > Secrets as `CODECOV_TOKEN`
### Arguments
| Input | Description | Usage |
| ------- | ----------------------------------------- | ------------ |
| `token` | Used to authorize coverage report uploads | **Required** |
| `file` | Location of the coverage report | Optional |
| `flags` | Flag upload under a certain group | Optional |
| `name` | Custom defined name for the upload | Optional |
See the Codecov [documentation](https://docs.codecov.io/docs) for details on how to use these arguments.
## License
The code in this project is released under the [MIT License](LICENSE).