Skip to content

Commit 0a51d2e

Browse files
jsorefafinetooth
andauthored
Spelling (coverallsapp#258)
* link: community-created language integrations Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * link: GitHub issues Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: github Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: macos Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: where the coverage was collected Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --------- Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> Co-authored-by: James Kessler <james@coveralls.io>
1 parent dc7137b commit 0a51d2e

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
shell: bash
2727
run: |
2828
echo "Running on Linux"
29-
- name: Set up environment (MacOS)
29+
- name: Set up environment (macOS)
3030
if: ${{ matrix.os == 'macos-latest' }}
3131
shell: bash
3232
run: |

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## How to contribute to the Coveralls Github Action
1+
## How to contribute to the Coveralls GitHub Action
22

33
#### **Did you find a bug?**
44

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This action's step needs to run after your test suite has outputted a coverage r
1414

1515
| Name | Requirement | Description |
1616
| ---------------------------- | ----------- | ----------- |
17-
| `github-token` | _required_ | Default if not specified: `${{ github.token }}`. Can also be specified this way: `github-token: ${{ secrets.GITHUB_TOKEN }}`; Coveralls uses this token to verify the appropriate repo at Coveralls and send any new status updates based on your coverage results. This variable is built into Github Actions, so __do not add it to your secrets store__. [More Info](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)|
17+
| `github-token` | _required_ | Default if not specified: `${{ github.token }}`. Can also be specified this way: `github-token: ${{ secrets.GITHUB_TOKEN }}`; Coveralls uses this token to verify the appropriate repo at Coveralls and send any new status updates based on your coverage results. This variable is built into GitHub Actions, so __do not add it to your secrets store__. [More Info](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)|
1818
| `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
| `files` | _optional_ | Default: all coverage files that could be found. Space-separated list of coverage report files produced by your test suite. Example: `files: coverage/test1.lcov coverage/test2.lcov` |
2020
| `format` | _optional_ | Force coverage report format. If not specified, coveralls will try to detect the format based on file extension and/or content. Possible values: `lcov`, `simplecov`, `cobertura`, `jacoco`, `gcov`, `golang`, `python`. See also [supported coverage report formats list](https://github.com/coverallsapp/coverage-reporter#supported-coverage-report-formats). |
@@ -25,7 +25,7 @@ This action's step needs to run after your test suite has outputted a coverage r
2525
| `carryforward` | _optional_ | Comma-separated flags used to carry forward results from previous builds if some of the parallel jobs are missing. Used only with `parallel-finished`. |
2626
| `coveralls-endpoint` | _optional_ | Hostname and protocol: `https://<host>`; Specifies a [Coveralls Enterprise](https://enterprise.coveralls.io/) hostname. |
2727
| `allow-empty` | _optional_ | Default: `false`. Don't fail if coverage report is empty or contains no coverage data. |
28-
| `base-path` | _optional_ | Path to the root folder of the project the coverage was collected in. Should be used in monorepos so that coveralls can process filenames from your coverage reports correctly (e.g. packages/my-subproject) |
28+
| `base-path` | _optional_ | Path to the root folder of the project where the coverage was collected. Should be used in monorepos so that coveralls can process filenames from your coverage reports correctly (e.g. packages/my-subproject) |
2929
| `git-branch` | _optional_ | Default: GITHUB_REF environment variable. Override the branch name. |
3030
| `git-commit` | _optional_ | Default: GITHUB_SHA environment variable. Override the commit SHA. |
3131
| `compare-ref` | _optional_ | Branch name to compare coverage with. Specify if you want to always check coverage change for PRs against one branch. |
@@ -123,7 +123,7 @@ The "Coveralls Finished" step needs to run after all other steps have completed;
123123
124124
## Demo
125125
126-
![demo](https://s3.amazonaws.com/assets.coveralls.io/Coveralls%20Github%20Action%20Demo%20-%20trimmed%20-%204.8x720.gif)
126+
![demo](https://s3.amazonaws.com/assets.coveralls.io/Coveralls%20GitHub%20Action%20Demo%20-%20trimmed%20-%204.8x720.gif)
127127
128128
### Steps shown:
129129
@@ -167,13 +167,13 @@ Coveralls.io is always free for open-source projects!
167167

168168
Create a [free account](https://coveralls.io/pricing) for your (public) repo at Coveralls, then use one of our [official integrations](https://docs.coveralls.io/integrations#official-integrations)—[coverage-reporter](https://github.com/coverallsapp/coverage-reporter), [github-action](https://github.com/coverallsapp/github-action) (this project!), or [orb](https://github.com/coverallsapp/orb)—to upload your coverage reports to the [Coveralls API](https://docs.coveralls.io/api-introduction).
169169

170-
Additionally, over 30 [community-created language integrations](https://docs.coveralls.io/integrations#language-integrations) exist for Coveralls.io, which you can find [here](https://docs.coveralls.io/integrations#language-integrations).
170+
Additionally, over 30 [community-created language integrations](https://docs.coveralls.io/integrations#language-integrations) exist for Coveralls.io.
171171

172172
## Getting help
173173

174174
[Get started](https://docs.coveralls.io/) with our [documentation here](https://docs.coveralls.io/).
175175

176-
Issues or Questions? Reach out to us [here](https://github.com/coverallsapp/github-action/issues), or at support@coveralls.io.
176+
Issues or Questions? Reach out to us using [GitHub issues](https://github.com/coverallsapp/github-action/issues), or at support@coveralls.io.
177177

178178
## Contributing
179179

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ runs:
115115
elif [ -f /opt/homebrew/bin/coveralls ]; then
116116
echo "/opt/homebrew/bin" >> $GITHUB_PATH
117117
else
118-
echo "Coveralls binary not found after installation (MacOS)."
118+
echo "Coveralls binary not found after installation (macOS)."
119119
[ "${{ inputs.fail-on-error }}" == "false" ] && exit 0
120120
exit 1
121121
fi

0 commit comments

Comments
 (0)