GitHub
通过 GitHub 交互或从 GitHub 事件触发工作流
GitHub 是全球领先的软件开发和版本控制平台,基于 Git 提供服务。它为开发者提供了一个协作环境,可以托管和审查代码、管理项目并共同构建软件。
使用 GitHub,您可以:
- 托管代码库:在公共或私有代码库中存储代码,并进行版本控制
- 协作开发:使用拉取请求(Pull Request)提议更改、审查代码并合并贡献
- 跟踪问题:创建、分配和管理问题,以组织工作和跟踪错误
- 自动化工作流:使用 GitHub Actions 自动构建、测试和部署代码
- 管理项目:通过项目板、里程碑和任务跟踪来组织工作
- 文档管理:使用 GitHub Pages 和 wikis 创建和维护文档
在 Sim 中,GitHub 集成使您的代理可以直接与 GitHub 仓库和工作流交互。这支持强大的自动化场景,例如代码审查协助、拉取请求管理、问题跟踪和仓库探索。您的代理可以获取仓库数据、分析代码更改、在拉取请求上发布评论以及以编程方式执行其他 GitHub 操作。此集成弥合了您的 AI 工作流与开发流程之间的差距,实现了代理与开发团队之间的无缝协作。
使用说明
通过 GitHub API 访问 GitHub 仓库、拉取请求和评论。在您的工作流中自动化代码审查、PR 管理和仓库交互。从推送、拉取请求和问题等 GitHub 事件触发工作流。
工具
github_pr
获取 PR 详情,包括差异和更改的文件
输入
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
owner | string | 是 | 仓库所有者 |
repo | string | 是 | 仓库名称 |
pullNumber | number | 是 | 拉取请求编号 |
apiKey | string | 是 | GitHub API 令牌 |
输出
参数 | 类型 | 描述 |
---|---|---|
content | string | 可读的 PR 摘要 |
metadata | object | 包括文件更改的详细 PR 元数据 |
github_comment
在 GitHub PR 上创建评论
输入
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
owner | string | 是 | 仓库所有者 |
repo | string | 是 | 仓库名称 |
body | string | 是 | 评论内容 |
pullNumber | number | 是 | 拉取请求编号 |
path | string | 否 | 审查评论的文件路径 |
position | number | 否 | 审查评论的行号 |
commentType | string | 否 | 评论类型 (pr_comment 或 file_comment) |
line | number | 否 | 审查评论的行号 |
side | string | 否 | 差异的侧面 (LEFT 或 RIGHT) |
commitId | string | 否 | 要评论的提交的 SHA |
apiKey | string | 是 | GitHub API 令牌 |
输出
参数 | 类型 | 描述 |
---|---|---|
content | string | 人类可读的评论确认 |
metadata | object | 评论元数据 |
github_repo_info
检索全面的 GitHub 仓库元数据,包括星标、分叉、问题和主要语言。支持公共和私有仓库,并可选择进行身份验证。
输入
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
owner | string | 是 | 仓库所有者 (用户或组织) |
repo | string | 是 | 仓库名称 |
apiKey | string | 是 | GitHub 个人访问令牌 |
输出
参数 | 类型 | 描述 |
---|---|---|
content | string | 人类可读的仓库摘要 |
metadata | object | 仓库元数据 |
github_latest_commit
检索 GitHub 仓库的最新提交
输入
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
owner | string | 是 | 仓库所有者 (用户或组织) |
repo | string | 是 | 仓库名称 |
branch | string | 否 | 分支名称 (默认为仓库的默认分支) |
apiKey | string | 是 | GitHub API 令牌 |
输出
参数 | 类型 | 描述 |
---|---|---|
content | string | 人类可读的提交摘要 |
metadata | object | 提交元数据 |
注意事项
- 类别:
tools
- 类型:
github