Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

@gh-bot/core

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@gh-bot/core

GitHub bot framework

latest
Source
npmnpm
Version
0.1.0
Version published
Maintainers
1
Created
Source

@gh-bot/core: GitHub bot creation framework

Looking for a simpler way to create bots? Try @gh-bot/cli, which allows writing simple scripts that trigger on commands.

@gh-bot/core is a simple framework to allow bot creation on GitHub. You can let the bot respond to multiple events like this:

const bot = new GhBot(token, repo, github_secret);
bot.on('command', (command, ghBot) => {
        bot.comment("## Hello world!");
});
bot.on('push', (branch, ghBot) => {
        bot.comment("## Hello world!");
});
bot.listen(port);
  • port is port the bot listens on.
  • token is the GitHub access token of the bot
  • repo is an arry of repo owner and repo name, like ["gh-bot", "core"]
  • github_secret is the secret to use for the webhooks.

Migrating from botio

If you already having existing botio code and don't want to rewrite it for @gh-bot/cli, you can use @gh-bot/botio which provides the Bot.io API with a modern base.

FAQs

Package last updated on 12 Mar 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts