{"id":21152341,"url":"https://github.com/devdbrandy/coverage-slackify","last_synced_at":"2026-01-27T01:02:11.714Z","repository":{"id":236578912,"uuid":"792895197","full_name":"devdbrandy/coverage-slackify","owner":"devdbrandy","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-23T14:13:04.000Z","size":228,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-18T23:56:52.036Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devdbrandy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-27T21:17:49.000Z","updated_at":"2024-06-23T14:10:45.000Z","dependencies_parsed_at":"2024-05-20T14:42:09.861Z","dependency_job_id":"fc217d49-fa2d-4d5d-88a8-24385941c999","html_url":"https://github.com/devdbrandy/coverage-slackify","commit_stats":null,"previous_names":["devdbrandy/coverage-slackify"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/devdbrandy/coverage-slackify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devdbrandy%2Fcoverage-slackify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devdbrandy%2Fcoverage-slackify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devdbrandy%2Fcoverage-slackify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devdbrandy%2Fcoverage-slackify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devdbrandy","download_url":"https://codeload.github.com/devdbrandy/coverage-slackify/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devdbrandy%2Fcoverage-slackify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28794534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T10:38:25.289Z","updated_at":"2026-01-27T01:02:11.694Z","avatar_url":"https://github.com/devdbrandy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coverage Slackify\n\nThe `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.\n\n\u003cimg src=\"docs/screenshots/coverage-slackify.png\"\u003e\n\n## Table of Contents\n\n1. [🚀 Features](#-features)\n2. [🔧 Installation](#-installation)\n3. [📋 Prerequisites](#-prerequisites)\n4. [🛠 Usage](#-usage)\n    1. [Via npm Task](#via-npm-task)\n    2. [Defining SLACK_WEBHOOK Environment Variable](#defining-slack_webhook-environment-variable)\n5. [🔧 Custom Configuration](#-custom-configuration)\n6. [🤝 Contributing](#-contributing)\n7. [📄 License](#-license)\n\n---\n\n## 🚀 Features\n\n- Easily incorporate code coverage summaries and build details into your Slack channels.\n- Define pass/fail thresholds for project coverage to keep your team informed about the state of your tests.\n- Works smoothly with popular CI/CD platforms like Jenkins, Travis CI, and GitHub Actions.\n- Handles scenarios where Git is not enabled or the Slack webhook is not provided with ease.\n- Customize default settings through `package.json` for a tailored integration.\n\n## 🔧 Installation\n\nYou can install [coverage-slackify](https://www.npmjs.com/package/coverage-slackify) via npm or yarn:\n\n```bash\nnpm install --save-dev coverage-slackify\n# or\nyarn add -D coverage-slackify\n```\n\n## 📋 Prerequisites\n\nBefore using [coverage-slackify](https://www.npmjs.com/package/coverage-slackify), make sure you have the following:\n\n- A Slack webhook URL from your Slack workspace.\n- Istanbul or Jest coverage report can be generated for your project.\n\n## 🛠 Usage\n\n### Via npm Task\n\nIf you prefer using npm tasks, you can include [coverage-slackify](https://www.npmjs.com/package/coverage-slackify) as part of your testing workflow:\n\n```json\n\"scripts\": {\n  \"test\": \"jest --coverage\",\n  \"test:ci\": \"npm test \u0026\u0026 coverage-slackify\"\n}\n```\n\nThen, you can run the task in your CI/CD pipeline:\n\n```bash\nSLACK_WEBHOOK=$SLACK_WEBHOOK npm run test:ci\n```\n\n### Defining SLACK_WEBHOOK Environment Variable\n\nYou can also define the Slack webhook directly as an environment variable:\n\n```json\n\"scripts\": {\n  \"test\": \"jest --coverage\",\n  \"test:ci\": \"npm test \u0026\u0026 SLACK_WEBHOOK=https://hooks.slack.com/xxxxx coverage-slackify\"\n}\n```\n\n\u003e **Note**: Be cautious about exposing your Slack webhook URL in public repositories.\n\n## 🔧 Custom Configuration\n\nYou can override default configurations by adding a `coverageSlackify` section in your `package.json`:\n\n```json\n\"coverageSlackify\": {\n  \"threshold\": 80,\n  \"projectName\": \"Coverage Slackify\",\n  \"coverageFiles\": [\n    \"coverage/coverage-final.json\"\n  ]\n}\n```\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! If you have any ideas, enhancements, or bug fixes, feel free to open an issue or create a pull request.\n\n## 📄 License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevdbrandy%2Fcoverage-slackify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevdbrandy%2Fcoverage-slackify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevdbrandy%2Fcoverage-slackify/lists"}