https://github.com/devdbrandy/coverage-slackify
https://github.com/devdbrandy/coverage-slackify
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devdbrandy/coverage-slackify
- Owner: devdbrandy
- License: mit
- Created: 2024-04-27T21:17:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-23T14:13:04.000Z (almost 2 years ago)
- Last Synced: 2025-09-18T23:56:52.036Z (9 months ago)
- Language: TypeScript
- Size: 223 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coverage Slackify
The `coverage-slackify` package allows you to effortlessly integrate code coverage summaries and build details into your Slack workflow. It simplifies the process of notifying your team about the health of your project's test coverage.
## Table of Contents
1. [🚀 Features](#-features)
2. [🔧 Installation](#-installation)
3. [📋 Prerequisites](#-prerequisites)
4. [🛠 Usage](#-usage)
1. [Via npm Task](#via-npm-task)
2. [Defining SLACK_WEBHOOK Environment Variable](#defining-slack_webhook-environment-variable)
5. [🔧 Custom Configuration](#-custom-configuration)
6. [🤝 Contributing](#-contributing)
7. [📄 License](#-license)
---
## 🚀 Features
- Easily incorporate code coverage summaries and build details into your Slack channels.
- Define pass/fail thresholds for project coverage to keep your team informed about the state of your tests.
- Works smoothly with popular CI/CD platforms like Jenkins, Travis CI, and GitHub Actions.
- Handles scenarios where Git is not enabled or the Slack webhook is not provided with ease.
- Customize default settings through `package.json` for a tailored integration.
## 🔧 Installation
You can install [coverage-slackify](https://www.npmjs.com/package/coverage-slackify) via npm or yarn:
```bash
npm install --save-dev coverage-slackify
# or
yarn add -D coverage-slackify
```
## 📋 Prerequisites
Before using [coverage-slackify](https://www.npmjs.com/package/coverage-slackify), make sure you have the following:
- A Slack webhook URL from your Slack workspace.
- Istanbul or Jest coverage report can be generated for your project.
## 🛠 Usage
### Via npm Task
If you prefer using npm tasks, you can include [coverage-slackify](https://www.npmjs.com/package/coverage-slackify) as part of your testing workflow:
```json
"scripts": {
"test": "jest --coverage",
"test:ci": "npm test && coverage-slackify"
}
```
Then, you can run the task in your CI/CD pipeline:
```bash
SLACK_WEBHOOK=$SLACK_WEBHOOK npm run test:ci
```
### Defining SLACK_WEBHOOK Environment Variable
You can also define the Slack webhook directly as an environment variable:
```json
"scripts": {
"test": "jest --coverage",
"test:ci": "npm test && SLACK_WEBHOOK=https://hooks.slack.com/xxxxx coverage-slackify"
}
```
> **Note**: Be cautious about exposing your Slack webhook URL in public repositories.
## 🔧 Custom Configuration
You can override default configurations by adding a `coverageSlackify` section in your `package.json`:
```json
"coverageSlackify": {
"threshold": 80,
"projectName": "Coverage Slackify",
"coverageFiles": [
"coverage/coverage-final.json"
]
}
```
---
## 🤝 Contributing
Contributions are welcome! If you have any ideas, enhancements, or bug fixes, feel free to open an issue or create a pull request.
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.