Gathering detailed insights and metrics for istanbul-slack-notify
Gathering detailed insights and metrics for istanbul-slack-notify
Installations
npm install istanbul-slack-notifyDeveloper
mattyboy
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
14.17.5
NPM Version
6.14.14
Statistics
5 Stars
56 Commits
9 Forks
2 Watching
2 Branches
5 Contributors
Updated on 16 Aug 2022
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
7,869,832
Last day
-19.8%
1,808
Compared to previous day
Last week
-10.7%
12,134
Compared to previous week
Last month
14.2%
56,197
Compared to previous month
Last year
-30.4%
3,171,263
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
4
Dev Dependencies
4
Versions
istanbul-slack-notify
Sends istanbul / jest coverage summary and git build details to Slack using a pass/fail threshold for project coverage.
If SLACK_WEBHOOK is not provided it prints total coverage info to console instead
Table of Contents
Installation
npm i --save-dev istanbul-slack-notify
Setup
Do not share incoming webhook URLs in public code repositories.
You will need to configure a webhook for your Slack team: https://api.slack.com/incoming-webhooks
You must define SLACK_WEBHOOK as an environment variable.
You can override other default settings in your package.json by adding the following section:
1 "coverage": { 2 "threshold": 100, 3 "projectName": "Istanbul Slack Notify", 4 "repositoryUrl": "https://github.com/mattyboy/istanbul-slack-notify", 5 "coverageFiles": ["coverage/coverage-final.json"], 6 "username": "coverage-bot", 7 "channel": "#random", 8 "haltOnFailure": true 9 }
Istanbul / Jest coverage report for your project must be generated first.
Examples
Via npm task
Passing SLACK_WEBHOOK at runtime
Define a couple of npm tasks in package.json, assuming you only want slack notify from you CI server.
1"test": "./node_modules/.bin/jest --coverage", 2"test-ci": "npm test && ./node_modules/.bin/istanbul-slack-notify",
Then run tests on your CI server as follows.
1export SLACK_WEBHOOK=https://hooks.slack.com/xxxxx 2SLACK_WEBHOOK=$SLACK_WEBHOOK npm run test-ci
Note: If you don't set the SLACK_WEBHOOK it will print totals coverage to console instead
Defining SLACK_WEBHOOK in package.json
While you can do this be sure it isn't in a public repo as you will expose your slack webhook url.
1"test": "./node_modules/.bin/jest --coverage && ./node_modules/.bin/istanbul-slack-notify", 2"test-ci": "npm test && SLACK_WEBHOOK=https://hooks.slack.com/xxxxx ./node_modules/.bin/istanbul-slack-notify",
Via cli
1export SLACK_WEBHOOK=https://hooks.slack.com/xxxxx 2SLACK_WEBHOOK=$SLACK_WEBHOOK ./node_modules/.bin/istanbul-slack-notify
Contributing
If you have any feedback or suggestions please let me know. We use this package as part of our CI process and are open to changes that would be valuable to us and others.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/mattyboy/istanbul-slack-notify/test.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/mattyboy/istanbul-slack-notify/test.yaml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mattyboy/istanbul-slack-notify/test.yaml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yaml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/mattyboy/istanbul-slack-notify/test.yaml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
Found 2/11 approved changesets -- score normalized to 1
Reason
9 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/test.yaml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 23 are checked with a SAST tool
Score
3.2
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More