Kafka: 4. GitHub Actions
本文档属于GitHub Actions & GitLab CI指南的一部分。您可以在此处查看完整指南：通过您的 GitHub Actions 或 GitLab CI 流水线启动一个真实的 Kafka 服务，运行测试并自动销毁。
👋 欢迎查阅 Stackhero 文档！
Stackhero 为您提供全托管的 Kafka cloud 环境，几分钟内即可就绪。您将获得：
- 消息大小与传输无限制：数据扩展无上限，无需担心限制。
- 一键式简单升级：平台始终保持最新，无需停机或手动操作。
- 在您专属的私有、专用基础设施上，持续享有高性能与强大安全性。
如果您希望加快部署速度并减少运维负担，Stackhero 提供的 Kafka cloud hosting 能为您助力。大约 5 分钟即可拥有可用于生产环境的集群。
您可以将以下内容保存为 .github/workflows/ci.yml。此后，每次 push 或 pull request 都会针对真实的 Kafka 实例运行测试。
name: CI with Kafka
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
env:
STACKHERO_TOKEN: ${{ secrets.STACKHERO_TOKEN }}
STACK_NAME: ci-kafka-${{ github.run_id }}-${{ github.run_attempt }}
INSTANCE: "10G" # 如有需要可修改（见第 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 netcat-openbsd
- name: 创建 Kafka 服务
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="kafka" \
--instance="$INSTANCE" \
--region="$REGION")
echo "SERVICE_ID=$SERVICE_ID" >> "$GITHUB_ENV"
stackhero service-wait-for --service="$SERVICE_ID"
- name: 运行 Kafka 测试
run: |
set -euo pipefail
config=$(stackhero service-configuration-get --service="$SERVICE_ID" --format=json)
host=$(echo "$config" | jq -r '.configuration.domain')
# Open a TCP connection to the broker port.
nc -z -w 5 "$host" 9092
echo "✅ Kafka 已可从 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()，确保无论结果如何都会执行，保证您的 Kafka 实例被删除，避免因未使用资源而产生费用。