Skip to content

Commit 2a829b9

Browse files
authored
Switch to v3 (#774)
1 parent 8e09eaf commit 2a829b9

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@
1111
**As of February 1, 2022, v1 has been fully sunset and no longer functions**
1212

1313
Due to the [deprecation](https://about.codecov.io/blog/introducing-codecovs-new-uploader/) of the underlying bash uploader,
14-
the Codecov GitHub Action has released `v2` which will use the new [uploader](https://github.com/codecov/uploader). You can learn
14+
the Codecov GitHub Action has released `v2`/`v3` which will use the new [uploader](https://github.com/codecov/uploader). You can learn
1515
more about our deprecation plan and the new uploader on our [blog](https://about.codecov.io/blog/introducing-codecovs-new-uploader/).
1616

1717
We will be restricting any updates to the `v1` Action to security updates and hotfixes.
1818

19-
### Migration from `v1` to `v2`
20-
The `v2` uploader has a few breaking changes for users
19+
### Migration from `v1` to `v3`
20+
The `v3` uploader has a few breaking changes for users
2121
- Multiple fields have not been transferred from the bash uploader or have been deprecated. Notably
2222
many of the `functionalities` and `gcov_` arguments have been removed. Please check the documentation
2323
below for the full list.
2424

2525
## Usage
2626

27-
To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (`@v2` is recommended) as a `step` within your `workflow.yml` file.
27+
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.
2828

2929
If you have a *private repository*, this Action also requires you to [provide an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) from [codecov.io](https://www.codecov.io) (tip: in order to avoid exposing your token, store it as a `secret`). Optionally, you can choose to include up to four additional inputs to customize the upload context. **For public repositories, no token is needed**
3030

@@ -33,7 +33,7 @@ Inside your `.github/workflows/workflow.yml` file:
3333
```yaml
3434
steps:
3535
- uses: actions/checkout@master
36-
- uses: codecov/codecov-action@v2
36+
- uses: codecov/codecov-action@v3
3737
with:
3838
token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
3939
files: ./coverage1.xml,./coverage2.xml # optional
@@ -108,7 +108,7 @@ jobs:
108108
pip install pytest-cov
109109
pytest --cov=./ --cov-report=xml
110110
- name: Upload coverage to Codecov
111-
uses: codecov/codecov-action@v2
111+
uses: codecov/codecov-action@v3
112112
with:
113113
token: ${{ secrets.CODECOV_TOKEN }}
114114
directory: ./coverage/reports/

0 commit comments

Comments
 (0)