GitLab CI/CD統合

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

前提条件

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

• GitLabアカウントとプロジェクトリポジトリ
• アプリが設定されたCapgoアカウント
• Node.jsとnpm/yarnがプロジェクトに設定されている

GitLab CI/CDの設定

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

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

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

__CAPGO_KEEP_0__	値	保護	マスク
CAPGO_TOKEN	あなたのCapgo APIトークン	✅ はい	✅ はい

ヒント

あなたのCapgo APIトークンを console.capgo.app/apikeysあなたのアプリIDはすでにあなたの capacitor.config.ts ファイルに設定されています。

Simple

Basic configuration that deploys to production on every push to the main branch:

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

Deploy feature branches to test channels for review and testing:

# 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

Tip

チャンネルでのテスト: フィーチャーチャンネルにデプロイした後、特定のチャンネルを使用するようにアプリを設定してアップデートをテストできます。チャンネルの設定についてさらに学ぶ 暗号化の使用.

「暗号化の使用」セクション

__CAPGO_KEEP_0__の暗号化機能を使用している場合 Capgo’s encryption feature暗号化鍵を設定した後

ローカルに、GitLab変数にあなたの秘密鍵を追加してください: ターミナル画面 locally, add your private key to GitLab variables:

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

このコンテンツを 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シークレット管理で、プライベートキーを保存してください
• 異なる環境用に異なるキーを使用してください

マルチチャネル設定

Multi-Channel Configurationの詳細については、 チャンネルドキュメント.

複数の環境とマージリクエストデプロイの完全な構成:

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

Multi-Environment with Manual Approval

コピー

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

Branch-Based Deployment Strategy

Section titled “Multi-Channel Configuration”

# 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

トラブルシューティング

一般的な問題

Pipeline が “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_KEEP_0__デプロイと、モバイルアプリのユーザーに一貫した、信頼性の高い更新を保証できます。

With GitLab CI/CD integration, you can automate your Capgo deployments and ensure consistent, reliable updates to your mobile app users.

セクションのタイトル：GitLab CI/CD統合から続けて

CI/CD自動化の計画に GitLab CI/CD統合を接続する を計画しています Capgo CI/CD Capgo CI/CDの製品ワークフローについて Capgo Native Builds Capgo Native Buildsの製品ワークフローについて Capgo Integrations Capgo Integrationsの製品ワークフローについて CI/CD統合 CI/CD統合の実装詳細について GitHub Actions統合 GitHub Actions統合の実装詳細について