用于触发工作流的 GitHub Action

这个 Action 使用 workflow_dispatch 事件来触发另一个 GitHub Actions 工作流。
该工作流必须配置为支持这种事件类型，例如 on: [workflow_dispatch]

这允许你链接工作流，典型的用例是有一个 CI 构建工作流，在完成时触发 CD 发布/部署工作流。这样你可以为 CI 和 CD 维护单独的工作流，并根据需要在它们之间传递数据。

关于 workflow_dispatch 事件的详细信息，请参阅这篇介绍此类触发器的博文

注意 1. GitHub 现在有一种名为"可重用工作流"的原生方式来链接工作流。请参阅重用工作流的文档。这种方法与 workflow_dispatch 有所不同，但值得记住。

注意 2. GitHub UI 会将此 Action 触发的工作流报告为"手动触发"，尽管它们实际上是通过另一个工作流和 API 以编程方式运行的。

注意 3. 如果你想通过 ID 引用目标工作流，你需要使用以下 REST API 调用列出它们：curl https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows -H "Authorization: token {{pat-token}}"

Action 输入

`workflow`

必需。 要触发和运行的工作流的名称、文件名或 ID。在查找工作流时会使用这三种可能性。例如：

workflow: My Workflow
# 或
workflow: my-workflow.yaml
# 或
workflow: 1218419

`inputs`

可选。 传递给工作流的输入（如果配置了的话），必须是 JSON 编码的字符串，例如 { "myInput": "foobar" }

`ref`

可选。 与触发的工作流运行一起使用的 Git 引用。引用可以是分支、标签或提交 SHA。如果省略，则使用触发工作流的上下文引用。如果你想在拉取请求上触发并在拉取请求分支的上下文中运行目标工作流，请将 ref 设置为 ${{ github.event.pull_request.head.ref }}。

`repo`

可选。 默认行为是在触发工作流的同一仓库中触发工作流，如果你希望在另一个 GitHub 仓库中"外部"触发，则提供所有者 + 仓库名称，中间用斜杠分隔，例如 microsoft/vscode。

当跨仓库触发时，你必须提供 token（见下文），否则会收到 "Resource not accessible by integration" 错误。
如果其他仓库的默认分支与调用仓库不同，你还必须提供 ref 输入，否则会收到 "No ref found" 错误。

`token`

可选。 默认情况下将使用标准的 github.token/GITHUB_TOKEN，你不再需要在此处提供自己的令牌。

⚠️ 重要： 当使用 repo 选项跨仓库调用时，你必须提供令牌。为此，创建一个具有仓库权限的 PAT 令牌，并通过密钥在此处传递，例如 ${{ secrets.MY_TOKEN }}。

此选项也为向后兼容保留，因为在旧版本中此字段是强制性的。

Action 输出

此 Action 输出一个名为 workflowId 的单一输出。

使用示例

- name: 调用没有输入的工作流
  uses: benc-uk/workflow-dispatch@v1
  with:
    workflow: My Workflow

- name: 调用带输入的工作流
  uses: benc-uk/workflow-dispatch@v1
  with:
    workflow: Another Workflow
    inputs: '{ "message": "blah blah", "something": true }'

- name: 调用另一个仓库中带输入的工作流
  uses: benc-uk/workflow-dispatch@v1
  with:
    workflow: my-workflow.yaml
    repo: benc-uk/example
    inputs: '{ "message": "blah blah", "something": false }'
    # 使用 `repo` 选项时需要。可以是 PAT 或从 GitHub 应用或 CLI 生成的令牌
    token: "${{ secrets.MY_TOKEN }}"