Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.97 KB

README.md

File metadata and controls

55 lines (39 loc) · 2.97 KB
Raw

Yappy, the GitHub Monitor

Patreon donate button FOSSA Status

Monitor your github repos by adding this bot to your server, set up a channel for it, and don't miss any events!

Information

Join our Discord server at https://discord.gg/HHqndMG

GitHub

When setting up the bot, the site will ask you to sign in with GitHub. This is temporary & allows the bot to confirm the user has perms in the repositories (enough to install an app!). Installing the app in repositories requires permissions so that the bot can receive events (webhooks) pertaining to those areas. For example, if the bot doesn't have permission to read PRs in the repository, GitHub doesn't allow it to receive webhooks for PR-related activity.

  • Dependabot Alerts: dependabot vulnerability alerts
  • Code / Contents: commit comment, create/delete branch, fork, gollum (wiki), push, release
  • Commit Statuses: commit statuses (doesn't seem to include workflow commit statuses! likely only external apps)
  • Issues: issue, milestone
  • Metadata: meta, label, public, repository, star, watch
  • Pages: GitHub pages failure events
  • Pull Requests: pull requests

This data is only "read" when receiving webhooks from GitHub (to convert into Discord embeds for the relevant channels) and when configuring the bot through the /setup command. In the latter case, the only API call made is to obtain "Metadata" to retrieve the list of available repositories for an installation. The access token is stored for <30 minutes while the user uses the setup dashboard, and then forgotten.

Discord

Commands

You can use the following commands through Discord Slash Commands.

Util:

  • help - a help command... yeah :P
  • invite - how to invite the bot and set up github events!
  • clean - cleans the bot's messages found in the last 100 messages
  • ping - uh... ping? pong!
  • stats - shows the stats of the bot... what else?

GitHub:

  • issue search <query> - search issues by any field in the global repo
  • issue info <number> - gives info about that specific issue in the global repo
  • pr search <query> - search pull requests by any field in the global repo
  • pr info <number> - gives info about that specific pr in the global repo

Admin:

  • conf option channel - view & edit the channel config
  • conf option guild - view & edit the server config
  • conf filter - set filter whitelist/blacklist for channel
  • setup - add & remove connections (repos, installations in orgs/accounts) from channel

Developer Documentation

https://yappybots.github.io/#/docs/yappygithub/