Meilisearch: 4. GitHub Actions

本文件是GitHub Actions 与 GitLab CI指南的一部分。您可以在这里查看完整指南:通过您的 GitHub Actions 或 GitLab CI pipeline 启动一个真实的 Meilisearch 服务,运行测试并自动销毁

欢迎来到 Stackhero 文档!

如果您需要一款快速、容错拼写且易于部署的搜索引擎,Stackhero 的 Meilisearch cloud 服务可以让您在几分钟内快速上手。您将获得以下优势:

  • 支持自定义域名,并集成了HTTPS,保障安全访问。
  • 简单的一键更新,无需手动操作。
  • 稳定的性能和强大的隔离性,专属私有独立基础设施

您只需 5 分钟,即可在 Stackhero 上部署 Meilisearch cloud hosting。整个配置流程旨在为您节省时间,让部署变得简单高效。

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

name: CI with Meilisearch

on: [push, pull_request]

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

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

      - name: 创建 Meilisearch 服务
        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="meilisearch" \
            --instance="$INSTANCE" \
            --region="$REGION")
          echo "SERVICE_ID=$SERVICE_ID" >> "$GITHUB_ENV"
          stackhero service-wait-for --service="$SERVICE_ID"

      - name: 针对 Meilisearch 运行测试
        run: |
          set -euo pipefail
          config=$(stackhero service-configuration-get --service="$SERVICE_ID" --format=json)
          host=$(echo "$config" | jq -r '.configuration.domain')
          # Call the Meilisearch health endpoint.
          curl -fsS "https://$host/health" | grep -q '"status":"available"'
          echo "✅ Meilisearch 已可从 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(),确保无论流程是否失败都会执行,及时删除 Meilisearch 实例,避免因未使用资源而产生费用。