@zhin.js/adapter-github

GitHub Plugin Runtime 适配器 — Issue/PR 评论区即聊天通道，GitHub App 认证，Webhook 入站经 httpHostToken。

功能特性

聊天通道：Issue/PR 评论区映射为群聊，支持收发消息
Webhook 入站：HMAC-SHA256 验签 → messageGatewayToken
出站：send({ target, payload }) → Issue/PR comment（target 为 channel ID）
GitHub App 认证：JWT → Installation Token
Agent 工具：agent/ 下 star/bind/subscribe/workspace 等保留

安装

bash

pnpm add @zhin.js/adapter-github

Webhook 需要 Root 提供 @zhin.js/host-http（zhin runtime start 默认装配）。

配置（Plugin Runtime）

yaml

# zhin.config.yml
plugins:
  github:
    webhook_path: /github/webhook
    auto_reply_repos:
      - zhinjs/zhin
    workspace_root: ./data/github-workspaces
    endpoints:
      - name: my-github-bot
        app_id: 123456
        private_key: ./data/github-app.pem
        webhook_secret: your-secret

env

GITHUB_APP_ID=123456
GITHUB_WEBHOOK_SECRET=your-secret

private_key 支持文件路径或 PEM 内容。未配置 webhook_secret 时仅 API 出站 / agent 工具可用（无入站）。

多 App：一个插件实例挂多个 endpoint（endpoints 数组逐项覆盖顶层字段，name 必填）：

yaml

plugins:
  github:
    endpoints:
      - name: app-a
        app_id: 123456
        private_key: ./data/app-a.pem
      - name: app-b
        app_id: 234567
        private_key: ./data/app-b.pem

已移除的配置

ai.githubMcp.enabled / ai.githubMcp.token：Plugin Runtime 迁移后 register-github-mcp（stdio @modelcontextprotocol/server-github，PAT 人身份）已移除，该配置不再生效。如需 MCP 工具，请按新运行时 mcp/<name>.ts（@zhin.js/mcp-feature）约定自行装配。
poll_interval：轮询降级已删除，仅 webhook 入站；该字段目前解析但不生效（deferred）。

Channel ID

类型	Channel ID	示例
Issue	`owner/repo/issues/N`	`zhinjs/zhin/issues/42`
PR	`owner/repo/pull/N`	`zhinjs/zhin/pull/108`

AI 工具

见 agent/tools/：github_star、github_bind、github_subscribe、github_prepare_workspace 等。

架构

路径	职责
`plugin.ts`	插件元数据；有 DatabaseHost 时定义 `github_oauth_users`
`adapters/github.ts`	薄 `defineAdapter` 入口（发现约定）
`src/endpoint.ts`	Endpoint 生命周期、出站、admit
`src/webhook.ts`	HMAC 验签与事件分发
`src/oauth-users.ts`	OAuth 表 SSOT + token 查找
`src/protocol.ts`	协议纯函数（channel / payload）
`src/gh-client.ts`	GitHub API 客户端

入站：httpHostToken POST → messageGatewayToken.receive
出站：send({ target, payload })

License

MIT

@zhin.js/adapter-github ​

功能特性 ​

安装 ​

配置（Plugin Runtime） ​

已移除的配置 ​

Channel ID ​

AI 工具 ​

架构 ​

License ​