actions/codecov-action
3
0
Fork 0
mirror of https://github.com/codecov/codecov-action.git synced 2026-02-12 22:17:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Erdoğan YOKSUL 2024-11-23 12:11:30 +03:00 committed by GitHub
parent 015f24e681
commit c800770d14
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -63,7 +63,7 @@ steps:
- uses: codecov/codecov-action@v5 - uses: codecov/codecov-action@v5
with: with:
fail_ci_if_error: true # optional (default = false) fail_ci_if_error: true # optional (default = false)
files: ./coverage1.xml,./coverage2.xml # optional file: coverage.xml
flags: unittests # optional flags: unittests # optional
name: codecov-umbrella # optional name: codecov-umbrella # optional
token: ${{ secrets.CODECOV_TOKEN }} token: ${{ secrets.CODECOV_TOKEN }}
@ -78,7 +78,7 @@ steps:
- uses: codecov/codecov-action@v5 - uses: codecov/codecov-action@v5
with: with:
fail_ci_if_error: true # optional (default = false) fail_ci_if_error: true # optional (default = false)
files: ./coverage1.xml,./coverage2.xml # optional file: coverage.xml
flags: unittests # optional flags: unittests # optional
name: codecov-umbrella # optional name: codecov-umbrella # optional
verbose: true # optional (default = false) verbose: true # optional (default = false)
@ -117,7 +117,7 @@ d as described here: https://docs.codecov.com/docs/codecov-yaml#can-i-name-the-f
| `env_vars` | Environment variables to tag the upload with (e.g. PYTHON \| OS,PYTHON) | Optional | `env_vars` | Environment variables to tag the upload with (e.g. PYTHON \| OS,PYTHON) | Optional
| `exclude` | Comma-separated list of folders to exclude from search. | Optional | `exclude` | Comma-separated list of folders to exclude from search. | Optional
| `fail_ci_if_error` | On error, exit with non-zero code | Optional | `fail_ci_if_error` | On error, exit with non-zero code | Optional
| `files` | Comma-separated explicit list of files to upload. These will be added to the coverage files found for upload. If you wish to only upload the specified files, please consider using "disable-search" to disable uploading other files. | Optional | `file` | File to upload. These will be added to the coverage files found for upload. If you wish to only upload the specified files, please consider using "disable-search" to disable uploading other files. | Optional
tional tional
| `flags` | Comma-separated list of flags to upload to group coverage metrics. | Optional | `flags` | Comma-separated list of flags to upload to group coverage metrics. | Optional
| `git_service` | Override the git_service (e.g. github_enterprise) | Optional | `git_service` | Override the git_service (e.g. github_enterprise) | Optional
@ -136,7 +136,7 @@ tional
| `override_build_url` | The URL of the build where this is running | Optional | `override_build_url` | The URL of the build where this is running | Optional
| `override_commit` | Commit SHA (with 40 chars) | Optional | `override_commit` | Commit SHA (with 40 chars) | Optional
| `override_pr` | Specify the pull request number manually. Used to override pre-existing CI environment variables. | Optional | `override_pr` | Specify the pull request number manually. Used to override pre-existing CI environment variables. | Optional
| `plugins` | Comma-separated list of plugins to run. Specify `noop` to turn off all plugins | Optional | `plugin` | Plugin to run. Specify `noop` to turn off all plugins | Optional
| `report_code` | The code of the report if using local upload. If unsure, leave unset. Read more here https://docs.codecov.com/docs/the-codecov-cli#how-to-use-local-upload | Optional | `report_code` | The code of the report if using local upload. If unsure, leave unset. Read more here https://docs.codecov.com/docs/the-codecov-cli#how-to-use-local-upload | Optional
| `report_type` | The type of file to upload, coverage by default. Possible values are "testing", "coverage". | Optional | `report_type` | The type of file to upload, coverage by default. Possible values are "testing", "coverage". | Optional
| `root_dir` | Root folder from which to consider paths on the network section. Defaults to current working directory. | Optional | `root_dir` | Root folder from which to consider paths on the network section. Defaults to current working directory. | Optional
@ -182,7 +182,7 @@ jobs:
directory: ./coverage/reports/ directory: ./coverage/reports/
env_vars: OS,PYTHON env_vars: OS,PYTHON
fail_ci_if_error: true fail_ci_if_error: true
files: ./coverage1.xml,./coverage2.xml,!./cache file: coverage.xml
flags: unittests flags: unittests
name: codecov-umbrella name: codecov-umbrella
token: ${{ secrets.CODECOV_TOKEN }} token: ${{ secrets.CODECOV_TOKEN }}