Skip to content
目录

介绍

TIP

要使用本插件,你需要安装数据库支持。

TIP

要启用屏幕截图相关功能,你需要安装 koishi-plugin-puppeteer。

koishi-plugin-github 封装了一系列 GitHub 相关的功能。比如监听 GitHub Webhooks,将收到的事件进行处理后发送到特定频道中。你还可以直接回复某条推送,通过快捷指令来实现进一步的功能,例如查看链接、进行评论、合并 PR 等等。

功能展示

基本用法

创建你的 OAuth App

  1. 访问你个人的 Settings → Developer Settings → OAuth Apps 页面,点击右上角的「New OAuth App」。

oauth-app-1

  1. 上面的两个随便填就可以,下面的 Callback URL 填写你机器人收取验证的地址(通常是你机器人的域名加上 /github/authorize)。配置完毕后点击「Register Application」就可以使用了。

oauth-app-2

填写插件的配置项

yaml
plugins:
  github:
    appId: your-github-app-id
    appSecret: your-github-app-secret

指令:github

指令:github.repos

指令:github.authorize