GitHub アクションの統合
このプラグインのインストール手順とフルマークダウンガイドを含む設定プロンプトをコピーする
Capgo Live UpdatesとGitHub Actionsを組み合わせて、codeの変更をプッシュしたときに自動的にアプリの更新を展開します。このガイドでは、GitHubの強力なCI/CDプラットフォームを使用して、自動ビルド、テスト、デプロイワークフローを設定します。
前提条件
「前提条件」のセクションGitHub Actions統合を設定する前に、以下のことを確認してください。
- アプリのソースcodeを含むGitHubリポジトリ
- アプリが設定されたCapgoアカウント
- プロジェクトにNode.jsとnpm/yarnが設定されている
- GitHub Actionsがリポジトリに有効になっている
GitHubシークレットの設定
セクションのタイトル “GitHub シークレットの設定”ステップ 1: リポジトリ シークレットの設定
セクションのタイトル “ステップ 1: リポジトリ シークレットの設定”GitHub リポジトリに必要なシークレットを設定してください:
- GitHub リポジトリに移動してください
- Go to 設定 → シークレットと変数 → アクション
- クリック 新しいリポジトリ シークレット と次の内容を追加してください:
| Secret Name | Value |
|---|---|
CAPGO_TOKEN | あなたのCapgo APIトークン |
シンプルなプロダクションデプロイ
「シンプルなプロダクションデプロイ」のセクションメインブランチへのプッシュごとにプロダクションにデプロイされるように設定された基本的な構成から始めましょう。
# Simple GitHub Actions Workflow for Capgo Live Updatesname: 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 deploymentname: 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’s encryption feature機能ブランチをテスト用の仮想チャネルに展開します。
After setting up encryption keys locally, add your private key to GitHub secrets:
# Display your private key content (copy this output)cat .capgo_key_v2Add this content as CAPGO_PRIVATE_KEY in your GitHub repository secrets, then use it in workflows:
# 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 productionMulti-Channel Configuration
Multi-Channel ConfigurationMulti-Channel設定についての詳細情報は、 チャンネルドキュメント.
開発、Pull Request、そしてプロダクションデプロイメントまでの完全なワークフロー:
# Complete multi-environment workflowname: 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で環境保護ルールを設定する
- Go to 設定 → 環境 __CAPGO_KEEP_0__
- 環境を作成する:
development,staging,production - 本番環境の場合、追加:
- 必要なレビュアー: 部門のメンバーを追加して、デプロイを承認する必要がある
- 待機タイマー: デプロイ前に待機時間を追加する (任意)
- デプロイブランチ: 以下のブランチのみ
main環境を制限する
機密情報のセキュアな管理
セクション:機密情報のセキュアな管理環境に応じた機密情報を使用:
# Use different secrets per environmentdeploy-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 }}Discord統合
セクション:Discord統合Discordへの通知を送信:
- 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"再利用可能なワークフロー
再利用可能なワークフローのセクションプロジェクト間で一貫性を保つために、再利用可能なワークフローを作成します:
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 }}__CAPGO_KEEP_0__/ワークフローの再利用:
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 }}次のステップ
セクション「次のステップ」- 学び チャンネル 異なるデプロイ環境を管理する
- 探索 カスタムストレージ 高度なデプロイシナリオ用
- セットアップ 暗号化 安全なデプロイ用に
- 設定 更新の動作をカスタマイズして、更新が適用される方法を変更する With __CAPGO_KEEP_0__ Actions統合機能を使用すると、__CAPGO_KEEP_1__の強力なCI/CDプラットフォームを活用して、__CAPGO_KEEP_2__ Live Updatesのための高度なデプロイワークフローを作成できます。デプロイワークフローには、組み込みのセキュリティ、監視、コラボレーション機能が含まれます。
With GitHub Actions integration, you can leverage GitHub’s powerful CI/CD platform to create sophisticated deployment workflows with built-in security, monitoring, and collaboration features for your Capgo Live Updates.
Keep going from GitHub Actions Integration
「GitHub Actions統合機能」を使用している場合__CAPGO_KEEP_0__ Actions統合機能 CI/CDの自動化を計画する場合、GitHub Actions統合機能を接続する If you are using __CAPGO_KEEP_0__ Actions Integration to plan CI/CD automation, connect it with __CAPGO_KEEP_0__ Actions Integration Capgo CI/CD Capgoの製品ワークフローについて Capgo Native Builds Capgoのネイティブビルドワークフローについて Capgo Integrations Capgoの統合ワークフローについて CI/CD統合 CI/CD統合の実装詳細について GitLab CI/CD統合 実装詳細について