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

slack-deploy-bot

v0.0.1

Published

A slack bot to remind you when a commit gets to different environments

Downloads

4

Readme

slack-deploy-bot

I found that I spent a lot of time checking if my commits had been deployed to certain environments. So this is a simple slack bot that will, when asked, send you a message to let you know when a commit has been deployed.

It exposes and endpoint that you can curl as a step in your deployment once it is complete e.g.

curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"environment": "ci", "commitHash": "347198c95b0c97f44418626872fbc7c95990031b"}' \
    -u user:password \
    localhost:8080 \

And if you have asked to be reminded about a commit that is before the one is deployed it will send you a message.

Configuration

slack-deploy-bot uses nconf for configuration, so therefore can be configured using (in order of precedence) :

  1. command line arguments
  2. environment variables
  3. configuration file config.json in working directory

In order for it to run you need to specify the following:

  • slackToken: Your slack api key
  • environments: A comma separated list of your environments
  • git:repoUrl: the remote url of your git repository (currently only tested with local file and https urls)

There are also the following optional options:

  • git:userName
  • git:password
  • git:repoDir: where you want deploybot to checkout the repository to
    • if this directory already contains the correct repo it will not re-clone
  • port: the port number you wish the web service to use
  • logFolder: where you wish the logs to be stored
  • storePath: where the database file is stored

Optionally you can also setup basic authentication for the deployment notification endpoint using the following options (both must be specified)

  • apiUserName: username used to secure the deploy notification endpoint
  • apiPassword: password used to secure the deploy notification endpoint

Quick start

npm install slack-deploy-bot -g
mkdir ~/deploybot
cd ~/deploybot
slack-deploy-bot --slackToken {yourslacktoken} --environments "ci, qa, live" --git:repoUrl "https://github.com/Rob-H/deploybot.git"