Kafka: 4. GitHub Actions
本文件是GitHub Actions 與 GitLab CI指南的一部分。請在此處查看完整指南：直接從您的 GitHub Actions 或 GitLab CI pipeline 啟動一個真實的 Kafka 服務，執行測試，並自動銷毀服務。
👋 歡迎來到 Stackhero 文件中心！
Stackhero 為您提供全方位受管理的 Kafka cloud 環境，幾分鐘內即可就緒。您可以期待以下優勢：
- 無限制的訊息大小與傳輸量：資料規模成長無須擔心上限。
- 一鍵式簡易更新：隨時保持平台最新，無需停機或手動操作。
- 穩定的高效能與強大的安全性，皆運行於您專屬的私有、專用基礎架構上。
如果您希望加快部署速度並減少營運負擔，Stackhero 的 Kafka cloud hosting 能協助您。只需約 5 分鐘，即可擁有可投入生產環境的叢集。
請將下列內容儲存為 .github/workflows/ci.yml。從此之後，每次 push 或 pull request 都會針對真實的 Kafka 實例執行測試。
name: 使用 Kafka 的 CI
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 與 client
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 實例被刪除，避免產生不必要的資源費用。