如何使用 http 请求将数据有效负载发送到 Github-Actions Workflow

Question

我想使用带有数据负载的http request 触发 Github-Actions 工作流，并在工作流脚本中使用此数据。但我找不到任何关于如何发送和使用该有效负载数据的文档。 我正在使用下面的curl 命令来触发工作流，但还需要发送和使用该数据有效负载。

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  --header 'Authorization: token ******' \
  https://api.github.com/repos/aashutosh0012/actions-test/actions/workflows/learn-github-actions.yml/dispatches \
  -d '{"ref":"main"}'

演示工作流程 Yaml 文件。

name: GitHub Actions Demo
on: [push, workflow_dispatch,repository_dispatch]
jobs:
  Explore-GitHub-Actions:
    runs-on: ubuntu-latest
    steps:
      - run: echo "???? The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "???? This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "???? The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v2
      - run: echo "???? The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "????️ The workflow is now ready to test your code on the runner."
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
          echo ${{ github}}
      - run: echo "???? This job's status is ${{ job.status }}."
      - run: echo "Aashutosh"
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: '3.x' # Version range or exact version of a Python version to use, using SemVer's version range syntax
          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
      
      - name: Run Python Script
        run: python test.py
      
      - name: Install python packages
        run: |
          python -m pip install --upgrade pip
          pip install requests Flask 
          pip list
          
      - name: Run Python Commands Single line
        run: python -c "import requests; print(dir(requests))"
      
      - name: Run Python Commands multi line
        uses: jannekem/run-python-script-action@v1
        id: script
        with:
          fail-on-error: false
          script: |
            from flask import Flask, request
            app = Flask(__name__)
            @app.route('/', methods=['POST'])
            def result():
                print(request.form['ref']) # should display 'bar'
                return 'Received !' # response to your request.

Answer 1

您可能会混淆repository_dispatch 和workflow_dispatch。存储库调度是您发送到存储库的事件。可以接收此事件，例如由 GitHub 应用程序使用，或者可用于通过使用 on: repository_dispatch 和工作流程的顶部来触发工作流程。

文档：

• 通过 API 触发 repository_dispatch 事件：https://docs.github.com/en/rest/reference/repos#create-a-repository-dispatch-event
• 设置工作流以在 respository_dispatch 事件上运行：https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#repository_dispatch

另一方面，工作流调度是关于直接触发工作流运行。这就像在 UI 上单击“运行此工作流”。这需要将您的工作流程设置为通过在工作流程顶部使用 on: workflow_dispatch 手动触发。

文档：

• 通过 API 触发 workflow_dispatch 事件：：https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event
• 设置要手动触发的工作流：https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch

---

创建repository_dispatch 事件的方法如下：

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/octocat/hello-world/dispatches \
  -d '{"event_type":"event_type", "client_payload": {"foo": "bar"}}'

（来自文档：https://docs.github.com/en/rest/reference/repos#create-a-repository-dispatch-event）

在您的操作中，您可以像这样访问有效负载：

  - run: 'echo "Foo: ${{ github.event.client_payload.foo }}"'

---

注意：您在问题中分享的工作流是由多个事件触发的——不仅仅是repository_dispatch。在其他情况下可能不会设置字段github.event.client_payload。