Skip to content

Commit

Permalink
Update README.md (#1073)
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasrockhu-codecov committed Sep 6, 2023
1 parent 7811627 commit db68c7a
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Expand Up @@ -5,7 +5,10 @@
[![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)
### 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
**As of February 1, 2022, v1 has been fully sunset and no longer functions**
Expand All @@ -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.

### 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

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.
Expand Down

0 comments on commit db68c7a

Please sign in to comment.