如何在GitHub Action中生成构建专属自定义Webhook回调URL并等待完成

针对你的场景，完全可以通过GitHub原生的repository_dispatch事件机制实现专属Webhook回调，替代轮询逻辑，具体步骤如下：

1. 核心思路 #

利用每个GitHub构建唯一的run_id作为标识，构造基于GitHub Repository Dispatch API的专属回调URL，让BrowserStack测试完成后调用该URL触发监听工作流，原工作流只需等待监听工作流的完成信号即可。

2. 主工作流：启动测试并传递专属回调URL #

在启动BrowserStack测试的工作流中，生成包含当前构建run_id的回调请求体，将GitHub的Repository Dispatch API地址作为Webhook URL传给BrowserStack：

name: Run BrowserStack Tests
on: [push, pull_request]

jobs:
  start-test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Generate callback payload and trigger BrowserStack test
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          RUN_ID: ${{ github.run_id }}
          BROWSERSTACK_USER: ${{ secrets.BROWSERSTACK_USERNAME }}
          BROWSERSTACK_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
        run: |
          # 构造带唯一run_id的回调请求体
          CALLBACK_PAYLOAD='{"event_type": "browserstack_test_done", "client_payload": {"run_id": "${RUN_ID}", "head_sha": "${{ github.sha }}"}}'
          # GitHub Repository Dispatch API地址作为回调URL
          WEBHOOK_URL="https://api.github.com/repos/${{ github.repository }}/dispatches"

          # 调用BrowserStack API启动测试，传入回调URL和payload
          curl -X POST "https://api.browserstack.com/automate/builds" \
            -u "${BROWSERSTACK_USER}:${BROWSERSTACK_KEY}" \
            -H "Content-Type: application/json" \
            -d '{
              "callback_url": "'"${WEBHOOK_URL}"'",
              "data": '"${CALLBACK_PAYLOAD}"'
            }'

      - name: Wait for test completion callback
        uses: lewagon/wait-for-check-action@v1.3.0
        with:
          ref: ${{ github.sha }}
          check-name: browserstack-test-completed
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          wait-interval: 10

3. 监听工作流：处理BrowserStack回调 #

创建独立的监听工作流，仅响应browserstack_test_done类型的repository_dispatch事件，验证run_id并处理测试完成后的逻辑，同时给原工作流发送完成信号：

name: BrowserStack Callback Listener
on:
  repository_dispatch:
    types: [browserstack_test_done]

jobs:
  process-test-result:
    runs-on: ubuntu-latest
    steps:
      - name: Validate build identity
        env:
          TARGET_RUN_ID: ${{ github.event.client_payload.run_id }}
        run: |
          echo "Processing test completion for build run ID: ${TARGET_RUN_ID}"
          # 这里可以添加逻辑，比如从BrowserStack拉取测试报告、存储结果等

      - name: Send completion signal to original workflow
        env:
          HEAD_SHA: ${{ github.event.client_payload.head_sha }}
        run: |
          curl -X POST "https://api.github.com/repos/${{ github.repository }}/check-runs" \
            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
            -H "Content-Type: application/json" \
            -d '{
              "name": "browserstack-test-completed",
              "head_sha": "'"${HEAD_SHA}"'",
              "status": "completed",
              "conclusion": "success"
            }'

关键注意事项 #

• 权限配置：确保GITHUB_TOKEN拥有repository_dispatch和checks:write权限（默认的GITHUB_TOKEN已包含这些权限）。
• 网络可达性：BrowserStack服务器需要能访问GitHub的API地址，若你的环境有网络限制需提前配置。
• 唯一性保障：github.run_id是每个构建的全局唯一标识，能确保回调准确关联到对应的测试任务。

内容的提问来源于stack exchange，提问作者user1936582