bahmutov / check-code-coverage Goto Github PK

Above 90 - bright green
80 - 90 - green
60 - 80 - yellow
less than 60 - red

https://shields.io/

The token is definitely being passed in, but for whatever reason isn't being found.

 Ensure coverage has not dropped 📈4s
    GITHUB_TOKEN: ***
Run DEBUG=check-code-coverage npx set-gh-status --check-against-readme
  DEBUG=check-code-coverage npx set-gh-status --check-against-readme
  shell: /bin/bash -e {0}
  env:
    GITHUB_TOKEN: ***
npx: installed 69 in 3.549s
Token must be provided!
##[error]Process completed with exit code 1.

It looks like this package assumes everything is at the root folder. After adding cd clients/html && to the npx line, it works, but then it's looking for the badge at the root-level README which doesn't have a badge.

• inspired by https://github.com/bahmutov/dependency-version-badge
• read total code coverage and update the badge in the README file

Current README:

![check-code-coverage](https://img.shields.io/badge/code--coverage-92.9%25-brightgreen)
![Master](https://github.com/dchbx/enroll-ui/workflows/Test,%20Lint,%20Build/badge.svg?branch=master)

Run DEBUG=check-code-coverage npx update-badge --from /Users/markgoho/Projects/enroll-ui/apps/admin-e2e/coverage/coverage-summary.json

check-code-coverage args: { _: [], '--from': '/Users/markgoho/Projects/enroll-ui/apps/admin-e2e/coverage/coverage-summary.json' } +0ms
  check-code-coverage reading coverage from { filename: '/Users/markgoho/Projects/enroll-ui/apps/admin-e2e/coverage/coverage-summary.json' } +0ms
  check-code-coverage reading coverage summary from: /Users/markgoho/Projects/enroll-ui/apps/admin-e2e/coverage/coverage-summary.json +0ms
  check-code-coverage clamped coverage: 92.9 +3ms
  check-code-coverage coverage regex: "/https:\/\/img\.shields\.io\/badge\/code--coverage-\d+%25-(:?red|yellow|green|brightgreen)/" +1ms
  check-code-coverage for coverage 92.9% badge color "brightgreen" +1ms
  check-code-coverage new coverage badge: "https://img.shields.io/badge/code--coverage-92.9%25-brightgreen" +0ms
⚠️ Could not find code coverage badge in file /Users/markgoho/Projects/enroll-ui/README.md
Insert new badge on the first line
  check-code-coverage inserting new badge: ![check-code-coverage](https://img.shields.io/badge/code--coverage-92.9%25-brightgreen) +0ms
saving updated readme with coverage 92.9%

Updated README:

![check-code-coverage](https://img.shields.io/badge/code--coverage-92.9%25-brightgreen) ![check-code-coverage](https://img.shields.io/badge/code--coverage-92.9%25-brightgreen)
![Master](https://github.com/dchbx/enroll-ui/workflows/Test,%20Lint,%20Build/badge.svg?branch=master)

P.S. ❤️ the debugging, it helps so much!

There is a package called set-gh-status in NPM registry, so using npx set-gh-startus will not work as expected, the correct snippet is:

- name: Set code coverage commit status 📫
  run: npx -p check-code-coverage set-gh-status
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

I will make a pull request to fix these errors.

Marks-MacBook-Pro:enroll-ui markgoho$ DEBUG=check-code-coverage npx update-badge --from apps/admin-e2e/coverage/coverage-summary.json
  check-code-coverage args: { _: [], '--from': 'apps/admin-e2e/coverage/coverage-summary.json' } +0ms
  check-code-coverage reading coverage from { filename: 'apps/admin-e2e/coverage/coverage-summary.json' } +0ms
  check-code-coverage reading coverage summary from: apps/admin-e2e/coverage/coverage-summary.json +1ms
Cannot find module 'apps/admin-e2e/coverage/coverage-summary.json'
Require stack:
- /Users/markgoho/Projects/enroll-ui/node_modules/check-code-coverage/src/index.js
- /Users/markgoho/Projects/enroll-ui/node_modules/check-code-coverage/bin/update-badge.js

Project folders:

Is npx doing something weird?

From https://github.com/bahmutov/check-code-coverage - probably using statements

By default should be .nyc_output, but could be any other file, like coverage/coverage-final.json for example

for cypress-io/code-coverage#205

To check multiple files at once

To not read it from a file, but to set it to a specific number between 0 and 100

Probably in the first line of the README

We are looking for a hacky way to fail a CI job based bash output.

✅ Total statement coverage 95.68% is >= minimum 95%

If we do not see a ✅, fail the job. Is this possible?

Extend check-total to look beyond statements. It appears, at the moment, check-total only checks against statements and not against lines, functions or branches.

check-total --from coverage/coverage-summary.json --min 80

Expected

Also support

check-total --from coverage/coverage-summary.json --min 80 --functions 63 --branches 53

Which would check against lines, functions and branches as well.

Additionally, if .nycrc is present then it can read the thresholds if not provided on cli.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• fix(deps): update dependency debug to v4.3.5
• chore(deps): update actions/checkout action to v4
• chore(deps): update dependency ava to v6
• chore(deps): update dependency prettier to v3
• chore(deps): update dependency semantic-release to v20
• chore(deps): update dependency semantic-release to v21
• chore(deps): update dependency semantic-release to v22
• chore(deps): update dependency semantic-release to v23
• chore(deps): update dependency semantic-release to v24
• fix(deps): update dependency arg to v5
• fix(deps): update dependency got to v12
• fix(deps): update dependency got to v13
• fix(deps): update dependency got to v14
• chore(deps): lock file maintenance
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency ava to v4
• chore(deps): update dependency ava to v5
• chore(deps): update dependency semantic-release to v19
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository