Mercure-Hub: 5. GitLab CI

このドキュメントはGitHub Actions & GitLab CIガイドの一部です。完全なガイドはこちらからご覧いただけます:GitHub Actions または GitLab CI パイプラインから実際の Mercure Hub サービスを起動し、テストを実行して、自動的に削除する方法

👋 Stackhero ドキュメントへようこそ!

Stackhero では、リアルタイムデータ配信をシンプルかつ信頼性高く実現する、フルマネージドの Mercure-Hub cloud サービスをご提供しています。主な特長は以下の通りです:

  • リクエスト数・メッセージサイズ無制限で、柔軟な運用が可能です。
  • HTTPS 対応の カスタムドメイン(例:https://real-time.your-company.com)を標準搭載。
  • ワンクリックアップデートで、常に最新の状態を簡単に維持できます。
  • プライベートかつ専用インフラ上での高いパフォーマンスと強固なセキュリティ
  • 複数リージョン対応:🇪🇺 ヨーロッパおよび🇺🇸 USAで低遅延配信を実現。

すぐに利用開始可能:わずか5分Mercure-Hub cloud hosting 環境を立ち上げ、アプリケーションへのリアルタイム更新配信をスタートできます。

以下の設定を .gitlab-ci.yml として保存してください。この構成では、パイプラインごとに新しい実際の Mercure Hub がテスト用に起動されます。

test:
  image: ubuntu:24.04
  variables:
    STACK_NAME: "ci-mercure-hub-$CI_PIPELINE_ID-$CI_JOB_ID"
    INSTANCE: "20G"   # 必要に応じて変更(ステップ3参照)
    REGION: "europe"
    SERVICE_STORE: "mercure-hub"
  # STACKHERO_TOKEN はステップ1で作成した CI/CD 変数から供給されます。
  script:
    - set -euo pipefail
    - curl -fsSL https://www.stackhero.io/install.sh | sh
    - apt-get update && apt-get install -y --no-install-recommends jq curl
    - STACK_ID=$(stackhero --format=script stack-create --name="$STACK_NAME")
    - echo "STACK_ID=$STACK_ID" >> deploy.env
    - SERVICE_ID=$(stackhero --format=script service-add --stack="$STACK_ID" --service-store="$SERVICE_STORE" --instance="$INSTANCE" --region="$REGION")
    - echo "SERVICE_ID=$SERVICE_ID" >> deploy.env
    - stackhero service-wait-for --service="$SERVICE_ID"
    - 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 から到達可能です。"
    # 上記の認証情報を使って独自のテストスイートも実行できます ...
  after_script:
    - test -f deploy.env && . ./deploy.env || true
    - >
      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

GitLab ではクリーンアップは after_script 内で行われます。このセクションはジョブが失敗しても必ず実行されるため、Mercure Hub リソースが確実に削除され、不要な課金を防げます。

GitLab では after_script新しいシェルで実行されます。そのため、ジョブ中にサービスIDやスタックIDを deploy.env に書き出し、クリーンアップ前に再ロードしています。これにより、ジョブ途中で失敗してもリソースが確実に削除されます。

以上が Mercure Hub の CI ライフサイクルの全体像です。スタック作成、サービス追加、待機、認証情報取得、スモークテスト、そして必ずクリーンアップ。各パイプライン実行ごとに実際の分離されたサービスが提供され、実行後は何も残りません。利用可能なコマンドや非対話型 STACKHERO_TOKEN 認証については、CLI の詳細ドキュメント もご参照ください。