跳转到主要内容

GitHub

当你的工作流需要对仓库、议题、拉取请求或工作流运行执行操作时,请使用 GitHub。它适合用于创建、更新、查找或审查代码协作工作的步骤。

配置

在配置此步骤之前,请先通过登录流程在你工作区的 Integrations 中连接 GitHub。如果没有可用的活动连接,步骤会显示警告,并提供指向 Integrations 的链接,而不是账号选择器。

参数表单

当你选择一个操作时,Arguments 部分会根据该操作的输入 schema 渲染一个表单。 如果你更喜欢手动编写完整的参数对象,请切换到 Raw JSON 选项卡。任一选项卡中的更改都会保持同步。

常见操作

诸如删除记录之类的破坏性操作,不会出现在工作流操作选择器中。

输出

此步骤会将 GitHub 响应存储为步骤输出。响应的形状取决于操作。 在后续步骤中使用完整的输出引用:

示例

  1. 打开 Integrations,如果你还没有连接过 GitHub,请先连接。
  2. 将一个 GitHub 步骤添加到你的工作流中。
  3. 在 Authentication 中选择一个已连接的账号。
  4. 在 Action 中选择 Create issue。
  5. 填写必填字段。对任何字段值,使用 Insert Variable 引用前一个步骤的输出。
  6. 点击步骤标题栏中的 Run 来测试该操作,然后在 Output 中查看返回的负载。

使用场景

处理新的错误报告

  1. Create issue
  2. Add labels
  3. Add assignees

审查拉取请求

  1. Get pull request
  2. Request reviewers
  3. Mark pull request ready

关闭已解决的工作

  1. List repository issues
  2. Close issue
  3. Create issue comment

备注

  • 此步骤依赖于你工作区中已连接的 GitHub 集成。
  • 工作流操作选择器会显示一组精选操作。带有 GitHub 工具的代理可以使用更多操作。
  • 登录界面可能会显示第三方授权品牌标识。

将 GitHub 作为代理工具使用

你也可以在 Agent Editor 中将 GitHub 添加为工具。打开代理,点击 Add tool,然后选择 GitHub。在工具设置面板中,选择代理应使用的已连接账号。代理会在相关于对话时调用 GitHub 操作。 另请参见:Integrations、Creating and Editing 和 Testing and Iteration