GitLab CI/CD統合

Integrate Capgo Live Updates with GitLab CI/CD to automatically deploy your app updates whenever you push code changes. This guide covers setting up automated builds, testing, and deployment workflows.

前提条件

GitLab CI/CDの設定にあたっては、以下の条件を満たしていることを確認してください。

• GitLabアカウントとプロジェクトリポジトリ
• A Capgo account with an app configured
• Node.js and npm/yarn configured in your project

GitLab CI/CDの設定

ステップ 1: 環境変数を設定する

まず、GitLabプロジェクトで必要な変数を設定する必要があります。

1. GitLabプロジェクトに移動する
2. Go to 設定 → CI/CD → 変数
3. 次の変数を追加する

変数名	値	保護された	マスクされた
CAPGO_TOKEN	あなたの Capgo API トークン	✅ はい	✅ はい

ヒント

あなたの Capgo API トークンを コンソールの capgo.app/apikeysファイルに既にアプリIDが設定されているため capacitor.config.ts シンプル

Simple

メインブランチへのプッシュごとに、基本的な設定でプロダクションにデプロイされる:

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

Advanced

機能ブランチのデプロイ

機能ブランチをテストチャンネルにデプロイしてレビューとテスト:

# 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の機能チャンネルにデプロイした後、特定のチャンネルを使用するようにアプリを設定してアップデートをテストできます。 Capgoアプリのチャンネル設定について.

暗号化の使用

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

GitLab変数にプライベートキーを追加してください。 ターミナル画面 コピー

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

GitLabプロジェクト変数にこの内容を追加してください CAPGO_PRIVATE_KEY GitLabプロジェクト変数に次の内容を追加してください (保護とマスクする)、そしてパイプラインで使用してください:

# 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

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

セクション「マルチエvironment with Manual Approval」

# 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. __CAPGO_KEEP_0__をマークする: APIのトークンを常に保護し、マスクする
2. ブランチ保護: __CAPGO_KEEP_0__のトークンを使用してプロダクションのデプロイ
3. アクセス制御: メンテナーのみに変数のアクセスを制限する
4. 定期的なローテーション: APIのトークンを定期的にローテーションする

セキュアなPipelineの構成

# 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 が見つかりません」で失敗します:

# 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統合を使用している場合 GitLab CI/CD統合 CI/CDの自動化を計画するには、GitLab CI/CDを__CAPGO_KEEP_0__ CI/CDと接続する必要があります。 Capgo CI/CD Capgo CI/CDの製品ワークフロー用 Capgo ネイティブビルド Capgo ネイティブビルドの製品ワークフロー用 Capgo インテグレーション Capgo CI/CD統合 CI/CD統合 __CAPGO_KEEP_0__ アクション統合 GitHub アクション統合の実装詳細 GitHub エディット