dbg
discord-bot-github
npm i discord-bot-github
dbg

discord-bot-github

GitHub repo updates displayed in Discord.

by Dylan Falconer

0.3.0 (see all)License:MITTypeScript:Not FoundCategories:Vanilla JavaScript Discord API, Vanilla JavaScript GitHub API
npm i discord-bot-github
Readme

Discord Bot [for] GitHub

Version 1.0.0

  • Displays notifications in your Discord channels when selected events are triggered.
  • Can utilise GitHub Webhook "secrets" to secure your updates for private or public repositories.

Setup

  1. Add a webhook to your repository pointing to https://discordbotgithub.herokuapp.com. Select any events you would like to listen for.

    To add a webhook, visit your repository on github.com, click the settings tab, then webhooks.

  2. Set the content type to application/json.
  3. Authorise the bot on your server by clicking this link.
  4. Once the bot is active on your Discord server, you can use the slash commands listed below.

About secrets

You can specify a secret value when subscribing to receive webhook events. Keep in mind this secret will be stored in plain text on a server somewhere.

Don't just enter your "default password" as the secret, use some random value, unrelated text, or best of all: a hashed value.

If anyone guesses your secret, they can also subscribe to your webhook events!

Usage

Commands all start with / and will give you tool-tips if you start typing in Discord.

CommandDescription
/dbg-add <org> <name> [secret] [previews]Subscribe the current channel to the repo webhook events. Optionally takes a secret. Optionally enable link previews.
/dbg-remove <org> <name>Unsubscribe the current channel from the repo webhook events.

Previews will not display if your repo is set to private.

Downloads/wk

2

GitHub Stars

308

LAST COMMIT

8mos ago

MAINTAINERS

1

CONTRIBUTORS

5

OPEN ISSUES

3

OPEN PRs

3
VersionTagPublished
0.3.0
latest
6yrs ago
0.1.0
beta
6yrs ago
No tutorials found
Add a tutorial