Workflow dispatch API 现在返回运行 ID

Source: GitHub Changelog

概览

当您使用 GitHub Actions 工作流调度 API 端点 触发工作流时，现在可以在响应中收到元数据，帮助您将请求映射到相应的工作流运行。

• 之前，此端点仅返回 204 No Content 状态码。
• 通过传入新的可选布尔参数 return_run_details，API 将返回 200 OK 响应，内容包括：
  • 工作流 ID
  • API URL
  • 工作流 URL

如果省略该参数，端点仍然返回 204 No Content。

GitHub CLI 支持

此功能在 GitHub CLI 中同样受支持，起始版本为 v2.87.0。

• 使用 gh workflow run 触发工作流调度。
• CLI 会返回已创建运行的 URL，可通过 gh run view 查看。
• 最新的 CLI 版本默认将 return_run_details 设置为 true。

好处

开发者现在可以轻松识别哪些工作流运行是由其 API 调用产生的，免去了大量轮询或自定义跟踪方案的需求。

了解更多关于工作流调度 API 的信息，请参阅 GitHub Actions 文档。