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: 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 及 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 實例未刪除而產生不必要的費用。