GitLab CI/CD 連携

code の変更をプッシュするたびに、Capgo Live Updates を GitLab CI/CD と連携してアプリのアップデートを自動デプロイしましょう。このガイドでは、ビルド、テスト、デプロイの自動化ワークフローのセットアップ方法を解説します。

前提条件

GitLab CI/CD連携を設定する前に、以下が準備されていることを確認してください：

• プロジェクトのリポジトリを持つGitLabアカウント
• アプリが設定済みの Capgo アカウント
• プロジェクトでNode.jsと npm/yarnが設定済みであること

GitLab CI/CD のセットアップ

ステップ 1: 環境変数の設定

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

1. GitLabプロジェクトへ移動
2. 以下に移動します： 設定 → CI/CD → 変数
3. 以下の変数を追加してください：

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

ヒント

Capgo API トークンはこちらから取得: console.capgo.app/apikeys. アプリIDはすでに設定済みです。 capacitor.config.ts ファイル。

シンプル

mainブランチへのpushごとに本番環境へデプロイする基本設定:

# .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 add $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

ヒント

Channelsでのテストフィーチャーチャンネルにデプロイした後、その特定のチャンネルを使用するように設定することで、アプリ内でアップデートをテストできます。詳細については アプリでのチャネル設定.

暗号化の利用

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

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

# Display your private key content (copy this output)
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のセキュアなシークレット管理にのみ保存してください
• 環境ごとに別のキーを使用する

マルチチャネル設定

複数のデプロイチャネルのセットアップと管理について詳しくは、 Channelsのドキュメント.

複数環境とマージリクエストデプロイを含む完全な設定:

# .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 add $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

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

保護された変数

1. 機密変数の設定: API トークンは常に保護対象としてマークし、マスクしてください
2. ブランチ保護: 本番環境へのデプロイには保護された変数を使用してください
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のデプロイを自動化し、モバイルアプリユーザーに一貫した信頼性の高いアップデートを確実に届けられます。

GitLab CI/CD連携の続き

使用している場合 GitLab CI/CD 連携 CI/CD自動化を計画するには、次と連携してください Capgo での CI/CD 設定 Capgo CI/CDでのプロダクトワークフローについては、 Capgo Native Build Capgo Native Buildsでのプロダクトワークフローについては、 Capgo インテグレーション Capgo インテグレーションでのプロダクトワークフロー向けに、 CI/CD 連携 CI/CD Integrationの実装詳細については、 GitHub Actions 連携 GitHub Actions Integrationの実装詳細については。