GitHub 网页触发器

GitHub 网页触发器 配置为监控 GitHub 存储库或组织 中的事件。

概述

GitHub 网页触发器监听 GitHub 组织或 存储库中的特定事件。 当组织或 存储库中发生 事件时,触发器将启动配置的自动化工作流。

身份验证

GitHub 网页触发器使用个人访问令牌进行用户身份验证,并且不需要 OAuth 连接。 有关创建和管理个人访问令牌的更多信息,请参阅管理您的个人访问令牌GitHub 网页触发器支持经典和细粒度的访问令牌。 确保个人访问令牌有效。

您可以将此令牌存储在 Credential Vault。 有关存储和维护凭据的更多信息,请参阅 Credential Vault 中的凭据和 lockers

支持的事件

GitHub 网页触发器支持组织和存储库级别的以下事件:

事件 描述
创建 创建文件、分支或标签时。
复刻 当一个存储库被分叉时。
问题评论 当评论被添加到问题或拉取请求时。
问题 在存储库级别创建问题时。
标签 从问题或拉取请求中添加或移除标签时。
拉取请求 当在存储库内的分支中创建拉取请求时。
拉取请求审查 当审核评论被添加到拉取请求时。
推送 向存储库分支推送时。
星标 当存储库被加星标时
监视 当为存储库内的特定事件启用监视选项时。

先决条件

确保满足以下先决条件:

  • Bot CreatorCitizen Developer 许可证。
  • 查看我的机器人EVENT TRIGGERS 权限。
  • 用于自动化所在文件夹的签入签出权限。
  • 一个有效的 GitHub 个人访问令牌.

设置

以下设置适用于 GitHub 网页触发器 :

GitHub 组织网页触发器的屏幕截图

GitHub 存储库网页触发器设置的屏幕截图

监听事件
选择触发器必须监控的一个或多个事件。
组织名称
输入 GitHub 组织名称。 该字段仅适用于 GitHub 组织网页触发器。
存储库名称
请输入 GitHub 组织内的存储库名称。 此字段仅适用于 GitHub 存储库网页触发器。
用户配置文件
输入 GitHub 用户配置文件。 此字段仅适用于 GitHub 存储库网页触发器
选择身份验证类型
个人访问令牌是默认的身份验证类型。 您可以在凭据选项中使用选择功能,从 Credential Vault 中选择存储的个人访问令牌,或直接在不安全字符串选项中输入个人访问令牌
响应(可选)
使用响应选项将触发器响应数据保存到记录变量中。 您可以创建一个新变量,或选择一个已有变量来存储此响应数据。 触发器响应数据以键值对格式捕获来自 GitHub webhook API 有效载荷响应正文的信息。 使用该键作为记录变量中的名称,使这些数据能够作为其他操作在自动化中的输入。
GitHub 网页触发器使用点符号 (.) 解析 webhook 键值对有效载荷。 您必须按照相同的格式为记录变量构建表达式。 例如,要使用 repository id 作为表达式,您必须输入 repository.id 作为键。 有关 GitHub webhook 有效载荷文档的详细信息,请参阅 GitHub webook events and payload
一旦机器人运行完成,Audit log 会在由触发事件运行的机器人中记录触发响应数据。