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.

AIでセットアップする

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. GitLabプロジェクトに移動してください。 設定 → 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 Deployments

機能ブランチをテストチャンネルに展開して、レビューとテストを行います:

# 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_KEEP_0__ を CI/CD 環境で安全に保存する必要があります。

After 設定した暗号化キーをローカルに追加し、 GitLab変数にプライベートキーを追加してください:

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

GitLabプロジェクト変数に次の内容を追加してください (保護とマスクを有効にし、パイプラインで使用します): CAPGO_PRIVATE_KEY クリップボードにコピー

# 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

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

protectedTokens

• 秘密をコミットしないようにしてください。 .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

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

保護された変数

1. 敏感な変数をマークする: API トークンは常に保護されたものとしてマスクしてください
2. Branch Protection: __CAPGO_KEEP_0__を使用したプロダクションデプロイ用の保護変数を使用します。
3. Access Control: メンテナのみに変数のアクセスを制限します。
4. Regular Rotation: APIのトークンを定期的にローテーションします。

Secure Pipeline Configuration

# 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通知を追加します:

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 fails with “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"

デバッグ Pipelining

トラブルシューティングに役立つ情報を追加して問題を解決します:

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

次のステップ

• 学びます チャンネル __CAPGO_KEEP_0__を異なるデプロイ環境を管理する
• Explore カスタムストレージ 高度なデプロイシナリオ向けに
• セットアップ 暗号化 セキュアなデプロイ用
• 設定 アップデートの動作 アップデートの適用方法をカスタマイズする

GitLab CI/CD統合を使用すると、自動化されたCapgoデプロイと、モバイルアプリのユーザーに一貫した、信頼性の高いアップデートを保証できます。