Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Remove / comment out-of-date section re: `coveralls-api-result`, only available in `v1.x`. 

Please send any questions, suggestions or requests re: this sole output option to [email protected].
  • Loading branch information
afinetooth authored Oct 17, 2024
1 parent 29d7fa2 commit 0db2c3c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,11 @@ This action's step needs to run after your test suite has outputted a coverage r
| `fail-on-error` | _optional_ | Default: `true`. Set to `false` to avoid CI failure when upload fails due to any errors. |
| `coverage-reporter-version` | _optional_ | Default: `latest`. Version of coverage-reporter to use. Make sure to prefix the version number with 'v'. For example: v0.6.9. Not available currently on macOS. |

### Outputs:

* `coveralls-api-result`: JSON response from the Coveralls API with a status code and url for the Job on Coveralls.
<!-- Leaving this here until we decide whether to bring back `coveralls-api-result` in v2 -->
<!-- Please submit any questions, suggestions, requests to: [email protected] -->
<!-- ### Outputs: -->
<!-- * `coveralls-api-result`: JSON response from the Coveralls API with a status code and url for the Job on Coveralls. -->
<!-- // Leaving this here until we decide whether to bring back `coveralls-api-result` in v2 -->

### Standard Example:

Expand Down

0 comments on commit 0db2c3c

Please sign in to comment.