Mercure-Hub: 4. GitHub Actions

本文档属于GitHub Actions & GitLab CI指南的一部分。您可以在此处查看完整指南:通过您的 GitHub Actions 或 GitLab CI 流水线启动一个真实的 Mercure Hub 服务,运行测试并自动销毁

👋 欢迎查阅 Stackhero 文档!

Stackhero 提供全托管的 Mercure-Hub cloud 服务,旨在让实时数据传递变得简单可靠。您将获得:

  • 无限制的请求次数和消息大小,满足您的全部灵活性需求。
  • 带有内置 HTTPS 安全的自定义域名(例如,https://real-time.your-company.com)。
  • 便捷的一键升级,让您的 Hub 始终保持最新,无需任何繁琐操作。
  • 专属私有基础设施上实现高性能与强安全性
  • 多区域支持:🇪🇺 欧洲🇺🇸 美国,实现低延迟数据传输。

快速启动:只需 5 分钟即可部署您的 Mercure-Hub cloud hosting 环境,立即为您的应用推送实时更新。

您可以将以下内容保存为 .github/workflows/ci.yml。此后,每次 push 或 pull request 都会针对真实的 Mercure Hub 实例运行测试。

name: CI with Mercure Hub

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      STACKHERO_TOKEN: ${{ secrets.STACKHERO_TOKEN }}
      STACK_NAME: ci-mercure-hub-${{ github.run_id }}-${{ github.run_attempt }}
      INSTANCE: "20G"   # 如有需要可修改(见第 3 步)
      REGION: europe
    steps:
      - uses: actions/checkout@v4

      - name: 安装 Stackhero CLI 及客户端
        run: |
          curl -fsSL https://www.stackhero.io/install.sh | sh
          apt-get update && apt-get install -y --no-install-recommends jq curl

      - name: 创建 Mercure Hub 服务
        run: |
          set -euo pipefail
          STACK_ID=$(stackhero --format=script stack-create --name="$STACK_NAME")
          echo "STACK_ID=$STACK_ID" >> "$GITHUB_ENV"
          SERVICE_ID=$(stackhero --format=script service-add \
            --stack="$STACK_ID" \
            --service-store="mercure-hub" \
            --instance="$INSTANCE" \
            --region="$REGION")
          echo "SERVICE_ID=$SERVICE_ID" >> "$GITHUB_ENV"
          stackhero service-wait-for --service="$SERVICE_ID"

      - name: 运行 Mercure Hub 测试
        run: |
          set -euo pipefail
          config=$(stackhero service-configuration-get --service="$SERVICE_ID" --format=json)
          host=$(echo "$config" | jq -r '.configuration.domain')
          # Request the hub endpoint and check it answers.
          curl -fsS -o /dev/null -w "%{http_code}" "https://$host/.well-known/mercure?topic=test" | grep -qE "^(200|400|401)$"
          echo "✅ Mercure Hub 已可从 CI 访问。"
          # 您也可以在此处使用上述凭据运行自定义测试套件 ...

      - name: 清理(始终执行,包括失败时)
        if: always()
        run: |
          if [ -n "${SERVICE_ID:-}" ]; then
            stackhero service-delete --service="$SERVICE_ID" --confirm
            stackhero service-wait-for --service="$SERVICE_ID"
          fi
          if [ -n "${STACK_ID:-}" ]; then
            stackhero stack-delete --stack="$STACK_ID" --confirm
          fi

清理步骤配置了 if: always(),确保无论结果如何都会执行,保证您的 Mercure Hub 实例被删除,避免因未使用资源而产生费用。