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.

protectedTokens

GitLab CI/CDの設定前に、以下の条件を満たしてください。

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

GitLab CI/CDの設定

環境変数を設定する

GitLabプロジェクトに移動してください。

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

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

Tip

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

「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」

__CAPGO_KEEP_0__ と __CAPGO_KEEP_1__ のトークンを取得する

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

# 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

ヒント

チャンネルでのテスト:機能チャンネルにデプロイした後、特定のチャンネンを使用してアプリを更新してテストすることができます。チャンネルの設定についてさらに学びましょう。 configuring channels in your app.

暗号化の使用

あなたが「__CAPGO_KEEP_0__」の暗号化機能を使用している場合 Capgo’s encryption featureCI/CD環境で、プライベートキーを安全に保存する必要があります。

設定後 ローカルで暗号化キーを設定した後、GitLab変数にプライベートキーを追加してください。 ターミナル画面

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

クリップボードにコピー 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

Security Best Practices:

Caution

• Never commit the __CAPGO_KEEP_0__ to version control .capgo_key_v2 __CAPGO_KEEP_0__ をバージョン管理システムにコミットしない
• Store the private key only in secure CI/CD secret management
• CI/CDシークレットマネージャーで安全な環境で秘密鍵のみを保存する

Use different keys for different environments

Multi-Channel Configuration 複数チャネル構成.

For comprehensive information about setting up and managing multiple deployment channels, see the

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

Channels documentation

本番展開に必要な手動承認が必要な場合:

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 RotationAPIのトークンを定期的にローテーションする

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

デバッグ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

次のステップ

• 学習について チャンネル __CAPGO_KEEP_0__を管理するための異なるデプロイ環境
• Explore カスタムストレージ 高度なデプロイシナリオのために
• セットアップ 暗号化 セキュアなデプロイのために
• 設定 更新動作 更新が適用される方法をカスタマイズするために

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

GitLab CI/CD統合から続ける

GitLab CI/CD統合を使用している場合 GitLab CI/CD統合 CI/CD自動化の計画に使用するGitLab CI/CD統合を Capgo CI/CD Capgo CI/CDの製品ワークフローに Capgoネイティブビルド Capgoネイティブビルドの製品ワークフローに Capgo統合 Capgo統合の製品ワークフローに CI/CD統合 CI/CD統合の実装詳細について GitHub アクション統合 for the implementation detail in GitHub Actions Integration.