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とnpm/yarnがプロジェクトに設定されています。

GitLab CI/CDの設定

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

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

1. まず、GitLabプロジェクトで必要な変数を設定してください。
2. アクセス 設定 → CI/CD → 変数
3. 次の変数を追加します。

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

ヒント

Capgo から API のトークンを取得します console.capgo.app.apikeysアプリIDはすでにファイルに設定されています。 capacitor.config.ts シンプル

「シンプル」

クリップボードにコピー

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

ヒント

チャンネルを使用したテスト:機能チャンネルに展開した後、特定のチャンネルを使用してアプリを構成して、更新をテストできます。チャンネルの構成についてさらに学びます。 アプリ内でチャンネルの設定.

暗号化の使用

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

後 暗号化キーをローカルに設定した後 ローカルに暗号化キーを設定した後

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

Branch-Based Deployment Strategy

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

# 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. Branch Protection: 生産用デプロイメントのために保護された変数を使用する
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

次のステップ

• Learn about チャンネル 環境を管理する
• Explore カスタムストレージ 高度な展開シナリオのために
• セットアップ 暗号化 安全なデプロイメントのために
• 設定 更新動作 アップデートの適用方法をカスタマイズする

GitLab CI/CD統合を使用すると、Capgo の自動デプロイと、モバイルアプリのユーザーに安定した更新を保証できます。

GitLab CI/CD統合から続けて

GitLab CI/CD統合を使用している場合 GitLab CI/CD統合 __CAPGO_KEEP_0__ CI/CDと接続する Capgo CI/CD Capgo Native Buildsの製品ワークフロー Capgo 本機ビルド Capgo Integrationsの製品ワークフロー 「Capgo Integrations」 製品ワークフローでCapgo Integrationsを使用 CI/CD統合 CI/CD統合の実装詳細については GitHub アクション統合 Capgoの実装詳細については、GitHub Actions統合です。