メインコンテンツにスキップ
Capgo - Capacitor アプリ用ライブ更新 Capgo

GitHub アクションの統合

Capgo Live UpdatesとGitHub Actionsを組み合わせて、codeの変更をプッシュしたときに自動的にアプリの更新をデプロイすることができます。このガイドでは、GitHubの強力なCI/CDプラットフォームを使用した自動ビルド、テスト、デプロイワークフローの設定について説明します。

前提条件

「前提条件」というセクション

GitHub Actions統合を設定する前に、以下のことを確認してください。

  • GitHubリポジトリとアプリのソースcode
  • Capgoアカウントとアプリが設定されている
  • Node.jsとnpm/yarnがプロジェクトに設定されています。
  • GitHub Actionsがリポジトリに有効になっています。

GitHubシークレットの設定

「GitHubシークレットの設定」のセクション

ステップ 1: リポジトリのシークレットを設定

「ステップ 1: リポジトリのシークレットを設定」のセクション

GitHub リポジトリに必要なシークレットを設定する

  1. GitHub リポジトリに移動
  2. Go to 設定 → シークレットと変数 → Actions
  3. クリック 新しいリポジトリのシークレット と次のものを追加してください。
シークレット名値
CAPGO_TOKENあなたの Capgo API トークン

シンプルなプロダクション デプロイ

シンプルなプロダクション デプロイ

メイン ブランチにプッシュするたびにプロダクションにデプロイされる基本的な構成から始めます:

# Simple GitHub Actions Workflow for Capgo Live Updates
name: Deploy to Capgo


on:
  push:
    branches:
      - main


jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6


      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - name: Install, test and build
        run: |
          npm ci
          npm run test
          npm run build


      - name: Deploy to Capgo
         run: |
           npm install -g @capgo/cli
           npx @capgo/cli bundle upload --channel production
          env:
            CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
           # For encrypted uploads, add: --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

高度なマルチ チャネル構成

高度なマルチ チャネル構成

機能ブランチのデプロイ

機能ブランチのデプロイ

機能ブランチをテスト用の仮想チャネルにデプロイします:

# Feature branch deployment
name: Deploy Feature Branch to Capgo


on:
  push:
    branches:
      - 'feature/**'


jobs:
  deploy-feature:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - run: |
          npm ci
          npm run test
          npm run build


      - name: Deploy to feature channel
        run: |
          CHANNEL_NAME=$(echo "${{ github.ref_name }}" | sed 's/[^a-zA-Z0-9]/-/g' | tr '[:upper:]' '[:lower:]')
          npm install -g @capgo/cli
          npx @capgo/cli channel create $CHANNEL_NAME --apikey ${{ secrets.CAPGO_TOKEN }} || true
                     npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel $CHANNEL_NAME

暗号化の使用

暗号化の使用

あなたが「__CAPGO_KEEP_0__」の暗号化機能を使用している場合 Capgoの暗号化機能を使用している場合、CI/CD環境で秘密鍵を安全に保存する必要があります。暗号化キーをローカルに設定した後、__CAPGO_KEEP_0__シークレットに秘密鍵を追加してください。

ターミナル画面 コピー 「GitHub」リポジトリのシークレットに次の内容を追加してください。その後、ワークフローで使用してください。

コピー
# Display your private key content (copy this output)
cat .capgo_key_v2

__CAPGO_KEEP_0__ CAPGO_PRIVATE_KEY GitHub

# Deploy with encryption
- name: Deploy to Capgo with Encryption
  run: |
    npm install -g @capgo/cli
    npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}" --channel production

マルチチャネル設定

マルチチャネル設定

マルチチャネル設定についての詳細な情報は、チャンネルドキュメントを参照してください 開発、プルリクエスト、そしてプロダクションデプロイメントの完全なワークフロー:.

クリップボードにコピー

# Complete multi-environment workflow
name: Deploy to Capgo


on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]


jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - run: |
          npm ci
          npm run test
          npm run build


      - uses: actions/upload-artifact@v6
        with:
          name: dist
          path: dist/


  deploy-development:
    if: github.ref == 'refs/heads/develop'
    needs: build
    runs-on: ubuntu-latest
    environment: development
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist/


      - run: |
          npm install -g @capgo/cli
          npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel development


  deploy-pr:
    if: github.event_name == 'pull_request'
    needs: build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist/


      - name: Deploy to PR channel
        run: |
          CHANNEL_NAME="pr-${{ github.event.number }}"
          npm install -g @capgo/cli
          npx @capgo/cli channel create $CHANNEL_NAME --apikey ${{ secrets.CAPGO_TOKEN }} || true
          npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel $CHANNEL_NAME


      - name: Comment PR
        uses: actions/github-script@v7
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `🚀 This PR has been deployed to Capgo channel: \`pr-${{ github.event.number }}\`\n\nTo test this update in your app, configure it to use this channel. [Learn how to configure channels →](/docs/live-updates/channels/#configuring-the-channel-in-your-app)`
            })


  deploy-production:
    if: github.ref == 'refs/heads/main'
    needs: build
    runs-on: ubuntu-latest
    environment: production
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist/


      - run: |
          npm install -g @capgo/cli
          npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel production

機能チャンネルのクリーンアップ

セクション “機能チャンネルのクリーンアップ”

ブランチが削除されたときに自動的に機能チャンネルをクリーンアップします:

name: Cleanup Feature Channels


on:
  delete:


jobs:
  cleanup:
    runs-on: ubuntu-latest
    if: github.event.ref_type == 'branch' && startsWith(github.event.ref, 'feature/')
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - name: Delete Capgo channel
        run: |
          CHANNEL_NAME=$(echo "${{ github.event.ref }}" | sed 's/[^a-zA-Z0-9]/-/g' | tr '[:upper:]' '[:lower:]')
          npm install -g @capgo/cli
          npx @capgo/cli channel delete $CHANNEL_NAME --apikey ${{ secrets.CAPGO_TOKEN }} || true

セキュリティとベストプラクティス

セクション “セキュリティとベストプラクティス”

環境保護ルール

環境保護規則

GitHubで環境保護規則を設定する

  1. Go to 設定 → 環境 リポジトリ内
  2. 環境を作成する development, staging, production
  3. プロダクション環境の場合、追加:
    • 必要なレビュアー: デプロイを承認する必要があるチームメンバーを追加する
    • : デプロイまでの待機時間 (任意) を追加するWait timer (任意)
    • 展開ブランチ: 限定する main ブランチのみ

セキュア シークレット マネジメント

セクション「セキュア シークレット マネジメント」

環境固有のシークレットを使用する:

# Use different secrets per environment
deploy-production:
  environment: production
  steps:
    - name: Deploy to Production
      run: |
        npx @capgo/cli bundle upload \
          --apikey ${{ secrets.CAPGO_PROD_TOKEN }} \
          --app ${{ secrets.CAPGO_PROD_APP_ID }} \
          --channel production

監視と通知

セクション「監視と通知」

Slack統合

セクション「Slack統合」

ワークフローにSlack通知を追加する:

name: Deploy with Notifications


jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      # ... deployment steps


      - name: Notify Slack on Success
        if: success()
        uses: 8398a7/action-slack@v3
        with:
          status: success
          text: '✅ Capgo deployment successful!'
          fields: repo,message,commit,author,action,eventName,ref,workflow
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}


      - name: Notify Slack on Failure
        if: failure()
        uses: 8398a7/action-slack@v3
        with:
          status: failure
          text: '❌ Capgo deployment failed!'
          fields: repo,message,commit,author,action,eventName,ref,workflow
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

ディスコード統合

ディスコード統合

ディスコードに通知を送信します:

- name: Discord notification
  if: always()
  uses: Ilshidur/action-discord@master
  with:
    args: |
      Capgo deployment ${{ job.status }}!
      App: ${{ secrets.CAPGO_APP_ID }}
      Channel: ${{ github.ref_name }}
      Commit: ${{ github.sha }}
  env:
    DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}

メール通知

メール通知の設定

メール通知を設定します:

- name: Send email notification
  if: failure()
  uses: dawidd6/action-send-mail@v3
  with:
    server_address: smtp.gmail.com
    server_port: 465
    username: ${{ secrets.EMAIL_USERNAME }}
    password: ${{ secrets.EMAIL_PASSWORD }}
    subject: 'Capgo Deployment Failed - ${{ github.repository }}'
    to: team@yourcompany.com
    from: ci-cd@yourcompany.com
    body: |
      Deployment failed for ${{ github.repository }}
      Branch: ${{ github.ref_name }}
      Commit: ${{ github.sha }}
      Workflow: ${{ github.workflow }}

トラブルシューティング

トラブルシューティング

デバッグワークフロー

デバッグ ワークフロー

問題を解決するためにデバッグ ステップを追加します。

- name: Debug environment
  run: |
    echo "Node version: $(node --version)"
    echo "NPM version: $(npm --version)"
    echo "Working directory: $(pwd)"
    echo "Files in dist/: $(ls -la dist/ || echo 'No dist directory')"
    echo "Environment variables:"
    env | grep -E "(GITHUB_|CAPGO_)" | sort


- name: Test Capgo CLI
  run: |
    npx @capgo/cli --version
    npx @capgo/cli app debug --apikey ${{ secrets.CAPGO_TOKEN }} --app ${{ secrets.CAPGO_APP_ID }}

一般的な問題と解決策

一般的な問題と解決策

「CAPGO_TOKEN not found」でワークフローが失敗します。

- name: Verify secrets
  run: |
    if [ -z "${{ secrets.CAPGO_TOKEN }}" ]; then
      echo "ERROR: CAPGO_TOKEN secret is not set"
      exit 1
    fi
    echo "CAPGO_TOKEN is set (length: ${#CAPGO_TOKEN})"
  env:
    CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}

ビルド アーティファクトが見つかりません。

- name: Debug artifacts
  run: |
    echo "Checking for build artifacts..."
    ls -la dist/ || echo "No dist directory found"
    find . -name "*.js" -o -name "*.html" | head -10

ネットワーク接続性の問題

- name: Test connectivity
  run: |
    ping -c 3 api.capgo.io || echo "Ping failed"
    curl -I https://api.capgo.io/health || echo "Health check failed"

再利用可能なワークフロー

Section titled “再利用可能なワークフロー”

プロジェクト間で一貫性を保つために、再利用可能なワークフローを作成します:

github/workflows/reusable-capgo-deploy.yml
name: Reusable Capgo Deploy


on:
  workflow_call:
    inputs:
      environment:
        required: true
        type: string
      channel:
        required: true
        type: string
    secrets:
      CAPGO_TOKEN:
        required: true
      CAPGO_APP_ID:
        required: true


jobs:
  deploy:
    runs-on: ubuntu-latest
    environment: ${{ inputs.environment }}
    steps:
      - uses: actions/checkout@v6


      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - name: Install and build
        run: |
          npm ci
          npm run build


      - name: Deploy to Capgo
        run: |
          npm install -g @capgo/cli
          npx @capgo/cli bundle upload \
            --apikey ${{ secrets.CAPGO_TOKEN }} \
            --app ${{ secrets.CAPGO_APP_ID }} \
            --channel ${{ inputs.channel }}

再利用可能なワークフローを使用します:

github/workflows/deploy.yml
name: Deploy App


on:
  push:
    branches: [main, develop]


jobs:
  deploy-dev:
    if: github.ref == 'refs/heads/develop'
    uses: ./.github/workflows/reusable-capgo-deploy.yml
    with:
      environment: development
      channel: development
    secrets:
      CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
      CAPGO_APP_ID: ${{ secrets.CAPGO_APP_ID }}


  deploy-prod:
    if: github.ref == 'refs/heads/main'
    uses: ./.github/workflows/reusable-capgo-deploy.yml
    with:
      environment: production
      channel: production
    secrets:
      CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
      CAPGO_APP_ID: ${{ secrets.CAPGO_APP_ID }}

次のステップ

Section titled “次のステップ”

With GitHub Actions統合、GitHubの強力なCI/CDプラットフォームを利用して、Capgo Live Updatesの高度なデプロイワークフローを作成できます。セキュリティ、監視、コラボレーションの機能が組み込まれています。