Skip to content

Commit 50c33ad

Browse files
committed
: Master
docs: update README
1 parent a76dd78 commit 50c33ad

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The action's step needs to run after your test suite has outputted an LCOV file.
1414

1515
| Name | Requirement | Description |
1616
| --------------------- | ----------- | ----------- |
17-
| `github-token` | _required_ | Must be in form `github-token: ${{ secrets.GITHUB_TOKEN }}`; Coveralls uses this token to verify the posted coverage data on the repo and create a new check based on the results. It is built into Github Actions and does not need to be manually specified in your secrets store. [More Info](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)|
17+
| `github-token` | _optional_ | Default: `${{ github.token }}`. Can be also used this way: `github-token: ${{ secrets.GITHUB_TOKEN }}`; Coveralls uses this token to verify the posted coverage data on the repo and create a new check based on the results. It is built into Github Actions and does not need to be manually specified in your secrets store. [More Info](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)|
1818
| `path-to-lcov` | _optional_ | Default: "./coverage/lcov.info". Local path to the lcov output file produced by your test suite. An error will be thrown if the file can't be found. This is the file that will be sent to the Coveralls API. |
1919
| `flag-name` | _optional (unique required if parallel)_ | Job flag name, e.g. "Unit", "Functional", or "Integration". Will be shown in the Coveralls UI. |
2020
| `parallel` | _optional_ | Set to true for parallel (or matrix) based steps, where multiple posts to Coveralls will be performed in the check. `flag-name` needs to be set and unique, e.g. `flag-name: run ${{ join(matrix.*, ' - ') }}` |
@@ -58,9 +58,7 @@ jobs:
5858
make test-coverage
5959
6060
- name: Coveralls
61-
uses: coverallsapp/github-action@master
62-
with:
63-
github-token: ${{ secrets.GITHUB_TOKEN }}
61+
uses: coverallsapp/github-action@v1
6462
```
6563
6664
### Complete Parallel Job Example:
@@ -91,10 +89,9 @@ jobs:
9189
- name: Test ${{ matrix.test_number }}
9290
run: make test-coverage-${{ matrix.test_number }}
9391
- name: Coveralls Parallel
94-
uses: coverallsapp/github-action@master
92+
uses: coverallsapp/github-action@v1
9593
with:
96-
github-token: ${{ secrets.GITHUB_TOKEN }}
97-
flag-name: run ${{ join(matrix.*, ' - ') }}
94+
flag-name: run-${{ join(matrix.*, '-') }}
9895
parallel: true
9996

10097
finish:
@@ -103,9 +100,8 @@ jobs:
103100
runs-on: ubuntu-latest
104101
steps:
105102
- name: Coveralls Finished
106-
uses: coverallsapp/github-action@master
103+
uses: coverallsapp/github-action@v1
107104
with:
108-
github-token: ${{ secrets.GITHUB_TOKEN }}
109105
parallel-finished: true
110106
carryforward: "run-1,run-2"
111107
```

action.yml

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ author: 'Nick Merwin (Coveralls, Inc.)'
55
inputs:
66
github-token:
77
description: 'Put secrets.GITHUB_TOKEN here'
8+
required: false
89
default: ${{ github.token }}
910
path-to-lcov:
1011
description: 'Path to lcov file'

0 commit comments

Comments
 (0)