From e7f4f977bd3dba07a6fda03be3053f1658992446 Mon Sep 17 00:00:00 2001 From: Christian Clauss Date: Thu, 17 Jul 2025 01:09:55 +0200 Subject: [PATCH] README.md: Use current actions/setup-node and LTS version of Node.js (#247) Node.js 16 and 18 are end-of-life. * https://github.com/actions/setup-node#supported-version-syntax * https://nodejs.org/en/about/previous-releases --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8c3b09c6..8b03088d 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ When running on `pull_request` events, a comment will be added to the PR with de ## Usage -This action's step needs to run after your test suite has outputted a coverage report file. Most major test runners can be configured to do so, very likely with the adition of a test coverage library, such as `simplecov` for `ruby`, `coverage.py` for `python`, or `istanbul` or `jest` for `javascript`, etc. +This action's step needs to run after your test suite has outputted a coverage report file. Most major test runners can be configured to do so, very likely with the addition of a test coverage library, such as `simplecov` for `ruby`, `coverage.py` for `python`, or `istanbul` or `jest` for `javascript`, etc. ### Inputs: | Name | Requirement | Description | | ---------------------------- | ----------- | ----------- | -| `github-token` | _required_ | Default if not specified: `${{ github.token }}`. Can be also 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)| +| `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)| | `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. | | `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` | | `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). | @@ -22,7 +22,7 @@ This action's step needs to run after your test suite has outputted a coverage r | `build-number` | _optional_ | Default: autodetected from CI. This should be the same for all jobs in a parallel build. Override this is useful if your CI tool assigns a different build number for each parallel build. | | `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.*, ' - ') }}` | | `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. | -| `carryforward` | _optional_ | Comma separated flags used to carryforward results from previous builds if some of the parallel jobs are missing. Used only with `parallel-finished`. | +| `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`. | | `coveralls-endpoint` | _optional_ | Hostname and protocol: `https://`; Specifies a [Coveralls Enterprise](https://enterprise.coveralls.io/) hostname. | | `allow-empty` | _optional_ | Default: `false`. Don't fail if coverage report is empty or contains no coverage data. | | `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) | @@ -60,10 +60,10 @@ jobs: - uses: actions/checkout@v4 - - name: Use Node.js 16.x - uses: actions/setup-node@v3 + - name: Install Node.js + uses: actions/setup-node@v4 with: - node-version: 16.x + node-version: lts/* - name: npm install, make test-coverage run: | @@ -91,10 +91,10 @@ jobs: - 2 steps: - uses: actions/checkout@v4 - - name: Use Node.js 16.x - uses: actions/setup-node@v3 + - name: Install Node.js + uses: actions/setup-node@v4 with: - node-version: 16.x + node-version: lts/* - name: npm install run: npm install @@ -133,7 +133,7 @@ The "Coveralls Finished" step needs to run after all other steps have completed; 4. The commit on GitHub shows a new check for Coveralls with details "First build on function-f at 92.0%", and links to the Job on Coveralls. 5. Line-by-line results indicate the new function is missing coverage. 6. Create a pull request with the new branch. -7. The `pull_request` check runs and the resulting coverage data triggers a `fail` status. +7. The `pull_request` check runs, and the resulting coverage data triggers a `fail` status. 8. A detailed comment is posted. ## Troubleshooting: @@ -142,7 +142,7 @@ The "Coveralls Finished" step needs to run after all other steps have completed; Ensure that: -1. Your workflow invokes the Coveralls action runs on pull requests, e.g.: +1. Your workflow invokes the Coveralls action that runs on pull requests, e.g.: ```yaml on: ["push", "pull_request"]