跳至正文
浏览文档
理解与接入数据

GitHub

将 GitHub 仓库接入 AVA。

每个 GitHub 数据源读取一个仓库,提供 issues 和 pull_requests 两张表。

数据可读取的信息
Issue 和 Pull Request编号、标题、状态、作者(含与仓库的关系、是否为机器人)、负责人、标签、评论数、创建时间、更新时间、关闭时间和链接。
Issue关闭原因或重新打开的状态。
Pull Request是否为草稿、是否已合并、合并时间。

公开仓库可以直接读取。读取私有仓库需要有相应权限的 GitHub 令牌。

连接参数

通过 SDK 或 CLI 的 @file 配置时,将 type 设为 github,把下列参数写在 options 中。

参数类型说明
repositorystring必填。填写 owner/name 或 GitHub 仓库链接。
tokenstringGitHub 令牌。省略时,CLI 依次读取 GH_TOKEN 和 GITHUB_TOKEN。
sincestring可选的 ISO 8601 日期或时间。不带时区偏移时按 UTC 处理。保留所有未关闭记录,以及从该时间起更新过的已关闭记录。
maxRecordsnumberIssue 和 Pull Request 去重后的总数上限。默认 10,000,取值为 1 至 100,000 的整数。
timeoutMsnumber读取时限,包含重试和限流等待。默认 60,000 毫秒,取值为 1 至 110,000 的整数。