Mosquitto: 4. GitHub Actions

此文件屬於GitHub Actions 及 GitLab CI指南的一部分。請在此處查看完整指南:直接於您的 GitHub Actions 或 GitLab CI pipeline 啟動一個真實的 Mosquitto 服務,執行測試,並自動清理資源

👋 歡迎瀏覽 Stackhero 文件!

Stackhero 為您提供一個全託管的 Mosquitto MQTT cloud 環境,專為高可靠性及靈活性而設:

  • 無限訊息吞吐量及數據傳輸,確保您的工作流程不會受到人為限制。
  • 透過您自設的外部 API,實現無限裝置認證,讓裝置接入及存取管理更輕鬆。
  • 進階 ACLs,可細緻控制 topics、用戶及操作權限。
  • 提供自訂網域名稱及內建HTTPS,確保端點安全並展現品牌形象(例如:https://mqtt.your-company.com)。
  • 零煩惱更新:只需一鍵即可套用功能改進或安全修補。
  • 穩定效能及強大安全性,每個實例均運行於專屬私有基礎設施

加速您的 IoT 項目,同時減少營運負擔。您只需數分鐘,即可啟動一個安全、可投入生產的 Mosquitto MQTT cloud hosting 實例。

請將下列內容儲存為 .github/workflows/ci.yml。此後,每次 push 或 pull request 都會針對真實的 Mosquitto 實例執行測試。

name: CI with Mosquitto

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      STACKHERO_TOKEN: ${{ secrets.STACKHERO_TOKEN }}
      STACK_NAME: ci-mosquitto-${{ github.run_id }}-${{ github.run_attempt }}
      INSTANCE: "200"   # 如有需要可調整(見步驟 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 mosquitto-clients

      - name: 建立 Mosquitto 服務
        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="mosquitto" \
            --instance="$INSTANCE" \
            --region="$REGION")
          echo "SERVICE_ID=$SERVICE_ID" >> "$GITHUB_ENV"
          stackhero service-wait-for --service="$SERVICE_ID"

      - name: 執行 Mosquitto 測試
        run: |
          set -euo pipefail
          config=$(stackhero service-configuration-get --service="$SERVICE_ID" --format=json)
          host=$(echo "$config" | jq -r '.configuration.domain')
user=$(echo "$config" | jq -r '.configuration.authenticationUsers[0].login')
password=$(echo "$config" | jq -r '.configuration.authenticationUsers[0].password')
          # Publish a test message to a topic.
          mosquitto_pub -h "$host" -p 8883 -u "$user" -P "$password" --capath /etc/ssl/certs -t "stackhero/ci" -m "hello"
          echo "✅ Mosquitto 已可由 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(),確保無論流程是否失敗都會執行,避免 Mosquitto 實例未刪除而產生不必要的費用。