Package Health Score

56 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.0.7	\|	03/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (1)

GitHub Stars: 73
Forks: 93
Contributors: 30

Direct Usage Popularity

The npm package hubot-pager-maint receives a total of 1 downloads a week. As such, we scored hubot-pager-maint popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package hubot-pager-maint, we found that it has been starred 73 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the hubot-pager-maint repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like hubot-pager-maint is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 11
Open PR: 4
Last Release: 4 years ago
Last Commit: 2 months ago

Further analysis of the maintenance status of hubot-pager-maint based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for hubot-pager-maint is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 3 Direct
Versions: 9
Install Size: 29.3 kB
Dist-tags: 1
# of Files: 14
Maintainers: 1
TS Typings: No

hubot-pager-maint has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

hubot-pager-maint

PagerDuty integration for Hubot but only for creating maintenance windows. Syntax is as such:

hubot pager maint Sun May 17 01:06:58 UTC 2020 10

A maintenance window will be created with all services with the "PROD" string.

Installation

In your hubot repository, run:

npm install hubot-pager-maint --save

Then add hubot-pager-maint to your external-scripts.json:

["hubot-pager-maint"]

Configuration

> Upgrading from v2.x? The HUBOT_PAGERDUTY_SUBDOMAIN parameter has been replaced with HUBOT_PAGERDUTY_FROM_EMAIL, which is sent along as a header to indicate the actor for the incident creation workflow. This would be the email address for a bot user in PagerDuty.

Environment Variable	Required?	Description
`HUBOT_PAGERDUTY_API_KEY`	Yes	The REST API Key for this integration.
`HUBOT_PAGERDUTY_FROM_EMAIL`	Yes	The email of the default "actor" user for incident creation and modification.
`HUBOT_PAGERDUTY_USER_ID`	No`*`	The user ID of a PagerDuty user for your bot. This is only required if you want chat users to be able to trigger incidents without their own PagerDuty user.
`HUBOT_PAGERDUTY_SERVICE_API_KEY`	No`*`	The Incident Service Key to use when creating a new incident. This should be assigned to a dummy escalation policy that doesn't actually notify, as Hubot will trigger on this before reassigning it.
`HUBOT_PAGERDUTY_SCHEDULES`	No	Provide a comma separated list of schedules identifiers (e.g. `PFGPBFY,AFBCGH`) to restrict queries to only those schedules.
`HUBOT_PAGERDUTY_SERVICE_QUERY`	No	Query in JSON string format to pass to PagerDuty

* - May be required for certain actions.

Webhook

Environment Variable	Required?	Description
`HUBOT_PAGERDUTY_ENDPOINT`	Yes	PagerDuty webhook listener on your Hubot's server. Must be public. Example: `/hook`.
`HUBOT_PAGERDUTY_ROOM`	Yes	Room in which you want the pagerduty webhook notifications to appear. Example: `#pagerduty`

To setup the webhooks and get the alerts in your chatrooms, you need to add the endpoint you define here (e.g /hooks) in the service settings of your PagerDuty accounts. You also need to define the room in which you want them to appear. That is, unless you want to spam all the rooms with alerts, but we don't believe that should be the default behavior. 😁

Example interactions

Trigger an incident assigned to a specific user:

technicalpickles&gt; hubot pager trigger jnewland omgwtfbbq
hubot&gt; technicalpickles: :pager: triggered! now assigning it to the right user...
hubot&gt; technicalpickles: :pager: assigned to jnewland!

Trigger an incident assigned to an escalation policy:

technicalpickles&gt; hubot pager trigger ops site is down
hubot&gt; Shell: :pager: triggered! now assigning it to the right user...
hubot&gt; Shell: :pager: assigned to ops!

Check on open incidents:

technicalpickles&gt; hubot pager sup
hubot&gt;
      Triggered:
      ----------
      8: 2014-11-05T20:17:50Z site is down - @technicalpickles - assigned to jnewland

      Acknowledged:
      -------------
      7: 2014-11-05T20:16:29Z omgwtfbbq - @technicalpickles - assigned to jnewland

Acknowledge triggered alerts assigned to you:

jnewland&gt; /pager ack
hubot&gt; jnewland: Incident 9 acknowledged

Resolve acknowledged alerts assigned to you:

jnewland&gt; /pager resolve
hubot&gt; jnewland: Incident 9 resolved

Check up coming schedule, and schedule shift overrides on it:

technicalpickles&gt; hubot pager schedules
hubot&gt; * Ops - https://urcompany.pagerduty.com/schedules#DEADBEE
technicalpickles&gt; hubot pager schedule ops
hubot&gt; * 2014-06-24T09:06:45-07:00 - 2014-06-25T03:00:00-07:00 technicalpickles
       * 2014-06-25T03:00:00-07:00 - 2014-06-26T03:00:00-07:00 jnewland
       * 2014-06-26T03:00:00-07:00 - 2014-06-27T03:00:00-07:00 technicalpickles
       * 2014-06-27T03:00:00-07:00 - 2014-06-28T03:00:00-07:00 jnewland
       * 2014-06-28T03:00:00-07:00 - 2014-06-29T03:00:00-07:00 technicalpickles
technicalpickles&gt; hubot pager override ops 2014-06-25T03:00:00-07:00 - 2014-06-26T03:00:00-07:00 chrislundquist
hubot&gt; Override setup! chrislundquist has the pager from 2014-06-25T06:00:00-04:00 until 2014-06-26T06:00:00-04:00
technicalpickles&gt; hubot pager schedule
hubot&gt; * 2014-06-24T09:06:45-07:00 - 2014-06-25T03:00:00-07:00 technicalpickles
       * 2014-06-25T03:00:00-07:00 - 2014-06-26T03:00:00-07:00 chrislundquist
       * 2014-06-26T03:00:00-07:00 - 2014-06-27T03:00:00-07:00 technicalpickles
       * 2014-06-27T03:00:00-07:00 - 2014-06-28T03:00:00-07:00 jnewland
       * 2014-06-28T03:00:00-07:00 - 2014-06-29T03:00:00-07:00 technicalpickles

Conventions

hubot-pager-me makes some assumptions about how you are using PagerDuty:

PagerDuty email matches chat email
- override with hubot pager me as
The Service used by hubot-pager-me should not be assigned to an escalation policy with real people on it. Instead, it should be a dummy user that doesn't have any notification rules. If this isn't done, the escalation policy assigned to it will be notified, and then Hubot will immediately reassign to the proper team

Development

Fork this repository, and clone it locally. To start using with an existing Hubot for testing:

Run npm install in hubot-pager-me repository
Run npm link in hubot-pager-me repository
Run npm link hubot-pager-me in your Hubot directory
NOTE: if you are using something like nodenv or similar, make sure your npm link from the same node version

There's a few environment variables useful for testing:

HUBOT_PAGERDUTY_NOOP: Don't actually make POST/PUT HTTP requests.
HUBOT_PAGERDUTY_TEST_EMAIL: Force email of address to this for testing.

Resources

hubot-pager-maint dependencies

async moment-timezone scoped-http-client

hubot-pager-maint development dependencies

chai coffee-script grunt grunt-cli grunt-contrib-watch grunt-mocha-test husky matchdep mocha release-it sinon sinon-chai

FAQs

What is hubot-pager-maint?

PagerDuty integration for Hubot . Visit Snyk Advisor to see a full health score report for hubot-pager-maint, including popularity, security, maintenance & community analysis.

Is hubot-pager-maint popular?

The npm package hubot-pager-maint receives a total of 1 weekly downloads. As such, hubot-pager-maint popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is hubot-pager-maint well maintained?

We found indications that hubot-pager-maint is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is hubot-pager-maint safe to use?

The npm package hubot-pager-maint was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 December-2024, at 06:07 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

hubot-pager-maint

PagerDuty integration for Hubot For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (1)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

hubot-pager-maint

Installation

Configuration

Webhook

Example interactions

Conventions

Development

Resources

hubot-pager-maint dependencies

hubot-pager-maint development dependencies

FAQs

What is hubot-pager-maint?

Is hubot-pager-maint popular?

Is hubot-pager-maint well maintained?

Is hubot-pager-maint safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

hubot-pager-maint

Installation

Configuration

Webhook

Example interactions

Conventions

Development

Resources

hubot-pager-maint dependencies

hubot-pager-maint development dependencies

FAQs

What is hubot-pager-maint?

Is hubot-pager-maint popular?

Is hubot-pager-maint well maintained?

Is hubot-pager-maint safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues