Skip to content

Commit

Permalink
: Master
Browse files Browse the repository at this point in the history
docs: update README
  • Loading branch information
mrexox committed Mar 1, 2023
1 parent a76dd78 commit 50c33ad
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Expand Up @@ -14,7 +14,7 @@ The action's step needs to run after your test suite has outputted an LCOV file.

| Name | Requirement | Description |
| --------------------- | ----------- | ----------- |
| `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)|
| `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)|
| `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. |
| `flag-name` | _optional (unique required if parallel)_ | Job flag name, e.g. "Unit", "Functional", or "Integration". Will be shown in the Coveralls UI. |
| `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.*, ' - ') }}` |
Expand Down Expand Up @@ -58,9 +58,7 @@ jobs:
make test-coverage
- name: Coveralls
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
uses: coverallsapp/github-action@v1
```

### Complete Parallel Job Example:
Expand Down Expand Up @@ -91,10 +89,9 @@ jobs:
- name: Test ${{ matrix.test_number }}
run: make test-coverage-${{ matrix.test_number }}
- name: Coveralls Parallel
uses: coverallsapp/github-action@master
uses: coverallsapp/github-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
flag-name: run ${{ join(matrix.*, ' - ') }}
flag-name: run-${{ join(matrix.*, '-') }}
parallel: true

finish:
Expand All @@ -103,9 +100,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Coveralls Finished
uses: coverallsapp/github-action@master
uses: coverallsapp/github-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
parallel-finished: true
carryforward: "run-1,run-2"
```
Expand Down
1 change: 1 addition & 0 deletions action.yml
Expand Up @@ -5,6 +5,7 @@ author: 'Nick Merwin (Coveralls, Inc.)'
inputs:
github-token:
description: 'Put secrets.GITHUB_TOKEN here'
required: false
default: ${{ github.token }}
path-to-lcov:
description: 'Path to lcov file'
Expand Down

0 comments on commit 50c33ad

Please sign in to comment.