GitLab CI/CD統合

Capgo Live UpdatesをGitLab CI/CDと統合して、コード変更をプッシュするたびにアプリのアップデートを自動的にデプロイします。このガイドでは、自動ビルド、テスト、デプロイメントワークフローの設定について説明します。

前提条件

GitLab CI/CD統合を設定する前に、以下を確認してください：

• プロジェクトリポジトリを持つGitLabアカウント
• アプリが構成されたCapgoアカウント
• プロジェクトでNode.jsとnpm/yarnが構成されていること

GitLab CI/CDの設定

ステップ1: 環境変数の構成

まず、GitLabプロジェクトで必要な変数を設定します：

1. GitLabプロジェクトに移動
2. Settings → CI/CD → Variablesに移動
3. 以下の変数を追加：

変数名	値	Protected	Masked
CAPGO_TOKEN	Capgo APIトークン	✅ はい	✅ はい

ヒント

Capgo APIトークンはconsole.capgo.app/apikeysから取得してください。アプリIDはcapacitor.config.tsファイルにすでに構成されています。

シンプル

mainブランチへのプッシュごとに本番環境にデプロイする基本構成：

# .gitlab-ci.yml - Simple Configuration
image: node:22

stages:
  - build
  - deploy

variables:
  npm_config_cache: "$CI_PROJECT_DIR/.npm"

build:
  stage: build
  script:
    - npm ci
    - npm run test
    - npm run build
  artifacts:
    paths:
      - dist/
    expire_in: 1 hour
  only:
    - main

deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
    # For encrypted uploads, add: --key-data-v2 "$CAPGO_PRIVATE_KEY"
  dependencies:
    - build
  only:
    - main

高度

フィーチャーブランチのデプロイメント

レビューとテストのためにフィーチャーブランチをテストチャネルにデプロイ：

# Feature branch deployment
deploy_feature:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - CHANNEL_NAME="feature-$(echo $CI_COMMIT_REF_NAME | sed 's/[^a-zA-Z0-9-]/-/g')"
    - npx @capgo/cli channel create $CHANNEL_NAME --apikey $CAPGO_TOKEN || true
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel $CHANNEL_NAME
  dependencies:
    - build
  only:
    - /^feature\/.*$/
  environment:
    name: feature/$CI_COMMIT_REF_NAME
    url: https://your-app.com/channels/$CHANNEL_NAME

ヒント

チャネルでのテスト: フィーチャーチャネルにデプロイした後、アプリを特定のチャネルを使用するように構成することでアップデートをテストできます。詳しくはアプリでチャネルを構成する方法をご覧ください。

暗号化の使用

Capgoの暗号化機能を使用している場合、CI/CD環境にプライベートキーを安全に保存する必要があります。

ローカルで暗号化キーを設定した後、プライベートキーをGitLab変数に追加します：

# プライベートキーの内容を表示（この出力をコピー）
cat .capgo_key_v2

この内容をCAPGO_PRIVATE_KEYとしてGitLabプロジェクト変数に追加し（protectedおよびmaskedとしてマーク）、パイプラインで使用します：

# Deploy with encryption
deploy_production:
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --key-data-v2 "$CAPGO_PRIVATE_KEY" --channel production

警告

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

• .capgo_key_v2ファイルをバージョン管理にコミットしないでください
• プライベートキーは安全なCI/CDシークレット管理にのみ保存してください
• 異なる環境には異なるキーを使用してください

マルチチャネル構成

複数のデプロイメントチャネルの設定と管理に関する包括的な情報については、チャネルドキュメントを参照してください。

複数の環境とマージリクエストのデプロイメントを含む完全な構成：

# .gitlab-ci.yml - Advanced Multi-Channel Configuration
image: node:22

stages:
  - build
  - deploy

variables:
  npm_config_cache: "$CI_PROJECT_DIR/.npm"

# Build stage
build:
  stage: build
  script:
    - npm ci
    - npm run test
    - npm run build
  artifacts:
    paths:
      - dist/
    expire_in: 24 hours

# Deploy to development channel
deploy_development:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel development
  dependencies:
    - build
  only:
    - develop
  environment:
    name: development

# Deploy merge requests to test channels
deploy_mr:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - CHANNEL_NAME="mr-$CI_MERGE_REQUEST_IID"
    - npx @capgo/cli channel create $CHANNEL_NAME --apikey $CAPGO_TOKEN || true
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel $CHANNEL_NAME
  dependencies:
    - build
  only:
    - merge_requests
  environment:
    name: review/$CI_MERGE_REQUEST_IID
    url: https://your-app.com/channels/mr-$CI_MERGE_REQUEST_IID
    on_stop: cleanup_mr

# Cleanup MR channels when MR is closed
cleanup_mr:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli channel delete mr-$CI_MERGE_REQUEST_IID --apikey $CAPGO_TOKEN || true
  when: manual
  environment:
    name: review/$CI_MERGE_REQUEST_IID
    action: stop
  only:
    - merge_requests

# Deploy to staging
deploy_staging:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel staging
  dependencies:
    - build
  only:
    - develop
  environment:
    name: staging

# Deploy to production
deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
  dependencies:
    - build
  only:
    - main
  environment:
    name: production

手動承認を伴うマルチ環境

手動承認が必要な本番デプロイメントの場合：

deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
  dependencies:
    - build
  only:
    - main
  when: manual
  environment:
    name: production

ブランチベースのデプロイメント戦略

異なるブランチを適切なチャネルに自動的にデプロイ：

# Dynamic channel deployment based on branch
deploy:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - |
      if [ "$CI_COMMIT_REF_NAME" = "main" ]; then
        CHANNEL="production"
      elif [ "$CI_COMMIT_REF_NAME" = "develop" ]; then
        CHANNEL="staging"
      else
        CHANNEL="development"
      fi
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel $CHANNEL
  dependencies:
    - build
  environment:
    name: $CHANNEL

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

Protected変数

1. 機密変数をマーク: APIトークンは常にprotectedおよびmaskedとしてマーク
2. ブランチ保護: 本番デプロイメント用にprotected変数を使用
3. アクセス制御: 変数へのアクセスをメンテナーのみに制限
4. 定期的なローテーション: APIトークンを定期的にローテーション

安全なパイプライン構成

# Use protected variables for production
deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
  only:
    refs:
      - main
    variables:
      - $CI_COMMIT_REF_PROTECTED == "true"

監視と通知

Slack統合

パイプラインにSlack通知を追加：

notify_success:
  stage: .post
  image: alpine:latest
  before_script:
    - apk add --no-cache curl
  script:
    - |
      curl -X POST -H 'Content-type: application/json' \
        --data '{"text":"✅ Capgo deployment successful for '"$CI_COMMIT_REF_NAME"'"}' \
        $SLACK_WEBHOOK_URL
  when: on_success

notify_failure:
  stage: .post
  image: alpine:latest
  before_script:
    - apk add --no-cache curl
  script:
    - |
      curl -X POST -H 'Content-type: application/json' \
        --data '{"text":"❌ Capgo deployment failed for '"$CI_COMMIT_REF_NAME"'"}' \
        $SLACK_WEBHOOK_URL
  when: on_failure

メール通知

GitLabプロジェクト設定でメール通知を構成、またはAPIを使用：

notify_email:
  stage: .post
  script:
    - |
      curl --request POST \
        --header "PRIVATE-TOKEN: $GITLAB_API_TOKEN" \
        --form "to=team@yourcompany.com" \
        --form "subject=Capgo Deployment Status" \
        --form "body=Deployment of $CI_COMMIT_REF_NAME completed with status: $CI_JOB_STATUS" \
        "https://gitlab.com/api/v4/projects/$CI_PROJECT_ID/emails"
  when: always

トラブルシューティング

一般的な問題

「Capgo CLI not found」でパイプラインが失敗:

# Debug CLI installation
debug_cli:
  script:
    - npm install -g @capgo/cli
    - which capgo || echo "Capgo CLI not found"
    - npx @capgo/cli --version

認証エラー:

# Verify token configuration
debug_auth:
  script:
    - |
      if [ -z "$CAPGO_TOKEN" ]; then
        echo "CAPGO_TOKEN is not set"
        exit 1
      fi
      echo "Token length: ${#CAPGO_TOKEN}"

ビルドアーティファクトが見つからない:

# List build outputs
debug_build:
  script:
    - ls -la dist/
    - find dist/ -type f -name "*.js" -o -name "*.html"

デバッグパイプライン

問題をトラブルシューティングするためのデバッグ情報を追加：

debug:
  stage: build
  script:
    - echo "Branch: $CI_COMMIT_REF_NAME"
    - echo "Commit: $CI_COMMIT_SHA"
    - echo "Build: $CI_PIPELINE_ID"
    - env | grep CI_ | sort
  only:
    - branches

次のステップ

• チャネルについて学び、異なるデプロイメント環境を管理
• 高度なデプロイメントシナリオのためのカスタムストレージを探索
• 安全なデプロイメントのための暗号化を設定
• アップデートの適用方法をカスタマイズするためのアップデート動作を構成

GitLab CI/CD統合により、Capgoデプロイメントを自動化し、モバイルアプリユーザーへの一貫性のある信頼性の高いアップデートを保証できます。