介绍 ​

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

功能展示 ​

基本用法 ​

将 Bot 部署在公网 ​

1. 本插件的监听功能基于 GitHub Webhook 运行，因此需要部署于公网 (参考服务器部署)
2. 部署完成后需要填写全局设置中的 selfUrl 字段 (控制台 -> 插件配置 -> 全局设置 -> 网络设置)

创建你的 OAuth App ​

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

2. 上面的两个随便填就可以，下面的 Callback URL 填写你机器人收取验证的地址。若配置项中的 path 未修改，则为机器人部署 url 加上 /github/authorize，其中 /github 对应配置项中 path。配置完毕后点击「Register Application」就可以使用了。

例如机器人部署在https://example.com，配置项中为path为默认值/github，callback URL则填写https://example.com/github/authorize

填写插件的配置项 ​

plugins:
  github:
    appId: your-oauth-app-client-id
    appSecret: your-oauth-app-client-secret

其他注意事项 ​

部分功能 (如仓库订阅) 需要用户具有较高级权限才可以设置。出现相关问题时可以通过调整用户权限解决 (控制台 -> 数据库 -> User 的 authority 权限)。

指令：github ​

指令：github.repos ​

指令：github.authorize ​