Skip to content

Commit 4c170c9

Browse files
committed
Add GitHub Actions example, note no token needed
The first line of the `codecov-action` README notes: > The latest release of this Action adds support for tokenless uploads > from GitHub Actions! With Travis CI changing its open source offerings, many projects will likely be switching to GitHub Actions. Add a brief example, and a link back to the repository's README. Also leave a note in the FAQ that tokens are not required if using the GitHub action.
1 parent e7ef287 commit 4c170c9

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@
44

55
## Guide
66

7+
### GitHub Actions
8+
A minimal configuration for public repos:
9+
10+
```yml
11+
steps:
12+
# (Other steps go here)
13+
- name: "Upload coverage to Codecov"
14+
uses: codecov/codecov-action@v1
15+
with:
16+
fail_ci_if_error: true
17+
verbose: true
18+
```
19+
20+
See [codecov/codecov-action](https://github.com/codecov/codecov-action) for
21+
more information, a [detailed example](https://github.com/codecov/codecov-action#example-workflowyml-with-codecov-action),
22+
and other options.
23+
724
### Travis Setup
825
926
Add the following to your `.travis.yml`:
@@ -65,7 +82,9 @@ commands = codecov
6582

6683
## Caveats
6784
### Private Repo
68-
Repository tokens are required for (a) all private repos, (b) public repos not using Travis-CI, CircleCI or AppVeyor. Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
85+
Repository tokens are required for (a) all private repos, (b) public repos not using the [Codecov GitHub Action][https://github.com/codecov/codecov-action], Travis CI, CircleCI or AppVeyor.
86+
87+
Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
6988

7089
### Cobertura Reports
7190
Cobertura reports can expire - Codecov will reject reports that are older than 12 hours. The logs contain details if a report expired.

0 commit comments

Comments
 (0)