mirror of
https://github.com/codecov/codecov-action.git
synced 2025-12-08 08:06:27 +00:00
Update README.md (#1073)
This commit is contained in:
11
README.md
11
README.md
@@ -5,7 +5,10 @@
|
|||||||
[](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
|
||||||
|
|
||||||
>The latest release of this Action adds support for tokenless uploads from GitHub Actions!
|
## v4 Beta Release
|
||||||
|
`v4` of the Codecov GitHub Action will use the [Codecov CLI](https://github.com/codecov/codecov-cli) to upload coverage reports to Codecov. Currently, `v4` is in late stages of development, and beta releases are expected in 2023 Q4.
|
||||||
|
|
||||||
|
`v3` versions and below will not have access to CLI features (e.g. global upload token).
|
||||||
|
|
||||||
## ⚠️ Deprecation of v1
|
## ⚠️ Deprecation of v1
|
||||||
**As of February 1, 2022, v1 has been fully sunset and no longer functions**
|
**As of February 1, 2022, v1 has been fully sunset and no longer functions**
|
||||||
@@ -16,12 +19,6 @@ more about our deprecation plan and the new uploader on our [blog](https://about
|
|||||||
|
|
||||||
We will be restricting any updates to the `v1` Action to security updates and hotfixes.
|
We will be restricting any updates to the `v1` Action to security updates and hotfixes.
|
||||||
|
|
||||||
### Migration from `v1` to `v3`
|
|
||||||
The `v3` uploader has a few breaking changes for users
|
|
||||||
- Multiple fields have not been transferred from the bash uploader or have been deprecated. Notably
|
|
||||||
many of the `functionalities` and `gcov_` arguments have been removed. Please check the documentation
|
|
||||||
below for the full list.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (`@v3` is recommended) as a `step` within your `workflow.yml` file.
|
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (`@v3` is recommended) as a `step` within your `workflow.yml` file.
|
||||||
|
|||||||
Reference in New Issue
Block a user