Skip to content

Commit 4582d54

Browse files
Update README.md (#1639)
* Update README.md * Add in the deprecated args
1 parent bb7467c commit 4582d54

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,29 @@
55
[![Workflow for Codecov Action](https://github.com/codecov/codecov-action/actions/workflows/main.yml/badge.svg)](https://github.com/codecov/codecov-action/actions/workflows/main.yml)
66
### Easily upload coverage reports to Codecov from GitHub Actions
77

8+
## v5 Release
9+
`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.
10+
11+
### Migration Guide
12+
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.
13+
14+
**The following arguments have been changed**
15+
- `file` (this has been deprecated in favor of `files`)
16+
- `plugin` (this has been deprecated in favor of `plugins`)
17+
18+
The following arguments have been added:
19+
20+
- `binary`
21+
- `gcov_args`
22+
- `gcov_executable`
23+
- `gcov_ignore`
24+
- `gcov_include`
25+
- `report_type`
26+
- `skip_validation`
27+
- `swift_project`
28+
29+
You can see their usage in the `action.yml` [file](https://github.com/codecov/codecov-action/blob/main/action.yml).
30+
831
## v4 Release
932
`v4` of the Codecov GitHub Action will use the [Codecov CLI](https://github.com/codecov/codecov-cli) to upload coverage reports to Codecov.
1033

0 commit comments

Comments
 (0)