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

github-webhooks-exec

v1.5.0

Published

Execute shell commands on GitHub webhook events.

Downloads

4

Readme

github-webhooks-exec

Execute shell commands on GitHub webhook events.

  • Works with pm2 to start automatically on boot
  • Queues commands to ensure sequential execution

Requirements

  • Node.js
  • pm2

Installation

npm install github-webhooks-exec

Initial setup

webhooks.js

Create webhooks.js in the directory where you want to execute shell commands from:

const { webhooks, queue, logger } = require('github-webhooks-exec');

webhooks.on('push', event => {
  logger.info('Received push event');
  const commands = [
    'set -e',
    // etc.
  ];
  queue.push(commands.join('; '));
});

.env

Create .env in the same directory:

GITHUB_WEBHOOKS_PORT=3000
GITHUB_WEBHOOKS_SECRET=password

Generate a long random string for GITHUB_WEBHOOKS_SECRET.

ecosystem.config.js

Create ecosystem.config.js:

module.exports = {
  apps: [
    {
      name: 'my-project-webhooks',
      script: './webhooks.js',
    },
  ],
};

Running the server

Ensure pm2 is installed and set up:

npm install -g pm2
pm2 startup

Start the server:

pm2 start ecosystem.config.js

Save the pm2 app list to be restored on reboot:

pm2 save

Adding the webhook on GitHub

In Settings > Webhooks of any GitHub repository or organization, add a webhook with the following settings:

| Field | Value | | --- | --- | | Payload URL | https://your.domain:3000/api/github/webhooks | | Content type | application/json | | Secret | The value of GITHUB_WEBHOOKS_SECRET in the .env file | | Which events would you like to trigger this webhook? | Just the push event | | Active | checked |

Viewing logs

Install pino-pretty:

npm i -g pino-pretty

Tail logs:

pm2 logs --raw | pino-pretty

API Reference

github-webhooks-exec provides the following named exports:

webhooks

A Webhooks instance initialized with GITHUB_WEBHOOKS_SECRET from .env.

See https://github.com/octokit/webhooks.js/

queue

A fastq instance that runs shell commands sequentially.

See https://github.com/mcollina/fastq

logger

A pino logger instance.

See https://github.com/pinojs/pino