{"id":22351884,"url":"https://github.com/screwdriver-cd/notifications-base","last_synced_at":"2025-07-30T07:31:50.916Z","repository":{"id":48824364,"uuid":"82979007","full_name":"screwdriver-cd/notifications-base","owner":"screwdriver-cd","description":"Base class for defining the behavior between screwdriver and notifications plugins","archived":false,"fork":false,"pushed_at":"2024-09-04T19:11:58.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":12,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-11-07T04:18:55.101Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cd.screwdriver.cd/pipelines/133","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/screwdriver-cd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-23T22:49:00.000Z","updated_at":"2022-08-18T21:56:38.000Z","dependencies_parsed_at":"2023-01-23T10:00:07.511Z","dependency_job_id":null,"html_url":"https://github.com/screwdriver-cd/notifications-base","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Fnotifications-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/screwdriver-cd","download_url":"https://codeload.github.com/screwdriver-cd/notifications-base/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228106386,"owners_count":17870438,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-12-04T12:16:15.426Z","updated_at":"2024-12-04T12:16:15.998Z","avatar_url":"https://github.com/screwdriver-cd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notifications Base\n[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]\n\n\u003e Base class for defining the behavior between screwdriver and notifications plugins\n\n## Usage\n\n```bash\nnpm install screwdriver-notifications-base\n```\n\n## Interface\nThis is an interface for receiving Screwdriver API events and sending notification to users based on their job settings.\n\n### notify\n\n#### Expected Outcome\n\nNotify the user based on their job settings, e.g. [email](https://github.com/screwdriver-cd/notifications-email), [slack](https://github.com/screwdriver-cd/notifications-slack).\n\n## Extending\nTo extend the base class, the functions to override are:\n1. `_notify`\n2. `events` (optional)\n\nOverride `events` if you want to send notification based on other events.\n\n## Testing\n\n```bash\nnpm test\n```\n\n## License\n\nCode licensed under the BSD 3-Clause license. See LICENSE file for terms.\n\n[npm-image]: https://img.shields.io/npm/v/screwdriver-notifications-base.svg\n[npm-url]: https://npmjs.org/package/screwdriver-notifications-base\n[downloads-image]: https://img.shields.io/npm/dt/screwdriver-notifications-base.svg\n[license-image]: https://img.shields.io/npm/l/screwdriver-notifications-base.svg\n[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/notifications-base.svg\n[issues-url]: https://github.com/screwdriver-cd/notifications-base/issues\n[status-image]: https://cd.screwdriver.cd/pipelines/133/badge\n[status-url]: https://cd.screwdriver.cd/pipelines/133\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Fnotifications-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrewdriver-cd%2Fnotifications-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Fnotifications-base/lists"}