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. Go to 設定 → CI/CD → 変数
3. __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ を追加する変数:

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

ヒント

あなたの Capgo API トークンを console.capgo.app.apikeys から取得する. __CAPGO_KEEP_0__ IDはすでにファイルに設定されています。 capacitor.config.ts file.

シンプル

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

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

暗号化キーをCI/CD環境で安全に保存する必要があります。

暗号化キーをCI/CD環境で安全に保存する必要があります。 Capgo’s encryption feature設定後

Using Encryption 暗号化の使用 ローカルに、GitLab変数にプライベートキーを追加してください:

# 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

Capgoの複数チャンネル設定についての詳細情報は、 チャンネルドキュメント.

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

# .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. ブランチ保護保護された変数を使用してプロダクション展開
3. アクセス制御: __CAPGO_KEEP_0__ のアクセスをメンテナのみに制限する
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

Email Notifications

Configure email notifications in your GitLab project settings or use the 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

Troubleshooting

Common Issues

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

Authentication errors:

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

デバッグPipeline

問題をトラブルシューティングするためにデバッグ情報を追加します:

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 エコタカトエトバート バートエトバートをコントエトバートに送了。 Capgo エコタカトエトバート バートエトバートをコントエトバートで、Capgo エコタカトエトバートに定体にしたバートエトバート。 Capgo バメストバートコントエトバート Capgo バメストバートで、Capgo バメストバートをコントエトバートで、バメストバートに定体にしたバートエトバート。 Capgo アシッドケトバートコントエトバート Capgo アシッドケトバートで、Capgo アシッドケトバートをコントエトバートで、アシッドケトバートに定体にしたバートエトバート。 CI/CD エコタカトエトバートコントエトバート。 CI/CD エコタカトエトバートをコントエトバートで、バートエトバートに定体にしたバートエトバート。 GitHub アシッドケトバートコントエトバート for the implementation detail in GitHub Actions Integration.