Skip to content

Commit 30402df

Browse files
committed
docs: update README
1 parent 02ec6dc commit 30402df

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The action's step needs to run after your test suite has outputted an LCOV file.
1515
| Name | Requirement | Description |
1616
| --------------------- | ----------- | ----------- |
1717
| `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)|
18-
| `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. |
18+
| `file` | _optional_ | Default: all coverage files that could be found. Local path to the coverage report file produced by your test suite. An error will be thrown if no file was found. This is the file that will be sent to the Coveralls API. Leave empty if you want to combine many files reports. |
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.*, ' - ') }}` |
2121
| `parallel-finished` | _optional_ | Set to true in the last job, after the other parallel jobs steps have completed, this will send a webhook to Coveralls to set the build complete. |
@@ -58,7 +58,7 @@ jobs:
5858
make test-coverage
5959
6060
- name: Coveralls
61-
uses: coverallsapp/github-action@v1
61+
uses: coverallsapp/github-action@v2
6262
```
6363
6464
### Complete Parallel Job Example:
@@ -89,7 +89,7 @@ jobs:
8989
- name: Test ${{ matrix.test_number }}
9090
run: make test-coverage-${{ matrix.test_number }}
9191
- name: Coveralls Parallel
92-
uses: coverallsapp/github-action@v1
92+
uses: coverallsapp/github-action@v2
9393
with:
9494
flag-name: run-${{ join(matrix.*, '-') }}
9595
parallel: true
@@ -100,7 +100,7 @@ jobs:
100100
runs-on: ubuntu-latest
101101
steps:
102102
- name: Coveralls Finished
103-
uses: coverallsapp/github-action@v1
103+
uses: coverallsapp/github-action@v2
104104
with:
105105
parallel-finished: true
106106
carryforward: "run-1,run-2"

0 commit comments

Comments
 (0)