mirror of
https://github.com/codecov/codecov-action.git
synced 2025-12-08 08:06:27 +00:00
Update README.md (#1639)
* Update README.md * Add in the deprecated args
This commit is contained in:
23
README.md
23
README.md
@@ -5,6 +5,29 @@
|
|||||||
[](https://github.com/codecov/codecov-action/actions/workflows/main.yml)
|
[](https://github.com/codecov/codecov-action/actions/workflows/main.yml)
|
||||||
### Easily upload coverage reports to Codecov from GitHub Actions
|
### Easily upload coverage reports to Codecov from GitHub Actions
|
||||||
|
|
||||||
|
## v5 Release
|
||||||
|
`v5` of the Codecov GitHub Action will use the [Codecov Wrapper](https://github.com/codecov/wrapper) to encapsulate the [CLI](https://github.com/codecov/codecov-cli). This will help ensure that the Action gets updates quicker.
|
||||||
|
|
||||||
|
### Migration Guide
|
||||||
|
The `v5` release also coincides with the opt-out feature for tokens for public repositories. In the repository settings page in codecov.io, you can set the ability for Codecov to receive a coverage report from ANY souce. This will allow contributors or other members of a repository to upload without needing access to the Codecov token.
|
||||||
|
|
||||||
|
**The following arguments have been changed**
|
||||||
|
- `file` (this has been deprecated in favor of `files`)
|
||||||
|
- `plugin` (this has been deprecated in favor of `plugins`)
|
||||||
|
|
||||||
|
The following arguments have been added:
|
||||||
|
|
||||||
|
- `binary`
|
||||||
|
- `gcov_args`
|
||||||
|
- `gcov_executable`
|
||||||
|
- `gcov_ignore`
|
||||||
|
- `gcov_include`
|
||||||
|
- `report_type`
|
||||||
|
- `skip_validation`
|
||||||
|
- `swift_project`
|
||||||
|
|
||||||
|
You can see their usage in the `action.yml` [file](https://github.com/codecov/codecov-action/blob/main/action.yml).
|
||||||
|
|
||||||
## v4 Release
|
## v4 Release
|
||||||
`v4` of the Codecov GitHub Action will use the [Codecov CLI](https://github.com/codecov/codecov-cli) to upload coverage reports to Codecov.
|
`v4` of the Codecov GitHub Action will use the [Codecov CLI](https://github.com/codecov/codecov-cli) to upload coverage reports to Codecov.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user