npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

deployment-notifier

v2.0.4

Published

Sends notifications about deployments for a Git repo

Downloads

19

Readme

Deployment Notifier

Build Status Coverage Status

Lets you know when you should deploy and when the deployment is complete.

Useful when:

  • You need a human to make a decision of which version to deploy (if you want to do that when committing, look at semantic-release or similar).
  • You're using Slack
  • You have another webhook that also needs to record deployment

Environment variables

All environment variables are required.

Define to notify Slack

  • NODE_DEPLOYMENT_NOTIFIER_SLACK_WEBHOOK_URL: URL to the Slack webhook
  • NODE_DEPLOYMENT_NOTIFIER_SLACK_CHANNEL: Slack channel name to post messages to, e.g. #deployments
  • NODE_DEPLOYMENT_NOTIFIER_SLACK_USERNAME: Username to use when posting, e.g. Row Bot

Define for generic webhook

  • NODE_DEPLOYMENT_NOTIFIER_WEBHOOK_URL: URL to use when posting webhook with deployment info
  • NODE_DEPLOYMENT_NOTIFIER_WEBHOOK_BASIC_AUTH_USERNAME: Basic auth username for webhook
  • NODE_DEPLOYMENT_NOTIFIER_WEBHOOK_BASIC_AUTH_PASSWORD: Basic auth password for webhook

Usage

Install module globally:

npm install -g deployment-notifier

Suggest deployment

Sends Slack notification with a suggestion to make a deployment.

Includes changelog (since last deployment).

Usage

  Usage: deployment-suggestion [options]

  Options:

    -h, --help                             output usage information
    -N, --app-name <app name>              Application name
    -T, --latest-deployment-tag <git tag>  Name of tag for latest deployment
    -U, --deploy-url <url>                 URL where a deployment can be started

Example

$ deployment-suggestion --app-name "some app" --tag-name v1.0.0 

Record deployment

Sends message after a deployment has completed, to both Slack webhook and HTTP webhook.

Includes changes in the new version.

Usage

  Usage: deployment-completed [options]

  Options:

    -h, --help                               output usage information
    -N, --app-name <app name>                Application name
    -M, --message <release notes>            Release notes (required unless providing tags)
    -P, --previous-deployment-tag <git tag>  Name of tag for previous deployment
    -T, --deployment-tag <git tag>           Name of tag for latest deployment
    -E, --environment <target environment>   The environment deployment was targeted at

License

MIT