GitLab CI/CD 통합

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 프롬프트를 복사하세요.

GitLab CI/CD와 함께 Capgo Live Updates를 통합하여 code 변경 사항을 푸시할 때마다 앱 업데이트를 자동으로 배포하세요. 이 가이드는 자동 빌드, 테스트, 및 배포 워크플로우를 설정하는 방법을 다룹니다.

필수 조건

GitLab CI/CD 통합을 설정하기 전에 다음을 확인하세요:

GitLab 계정과 프로젝트 저장소가 있습니다.
A Capgo 계정에 앱이 설정된 경우
Node.js 및 npm/yarn이 프로젝트에 설정된 경우

GitLab CI/CD 설정

1단계: 환경 변수 설정

먼저 GitLab 프로젝트에서 필요한 변수를 설정하세요:

GitLab 프로젝트로 이동하세요
GitLab 프로젝트로 이동하세요 설정 → CI/CD → 변수
__CAPGO_KEEP_0__ __CAPGO_KEEP_1__ 변수를 추가하세요:

변수 이름	값	보호	가려진
`CAPGO_TOKEN`	Capgo API 토큰을 얻으세요	✅ 예	✅ 예

기본

기본 설정: 빌드가 메인 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

고급

__CAPGO_SECTION_2__ 제목: 기능 branch 배포

__CAPGO_COPY_TO_CLIPBOARD_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

제목 ‘암호화 사용’

, CI/CD 환경에서 개인 키를 안전하게 저장해야 합니다. Capgo’s encryption feature__CAPGO_KEEP_0__

Testing with Channels Using Encryption 지정된 GitLab 변수에 개인 키를 추가하세요:

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

이 내용을 CAPGO_PRIVATE_KEY GitLab 프로젝트 변수에 추가하세요 (보호 및 가려진 상태로 표시) 및 PIPELINES에서 사용하세요:

# 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

다중 채널 구성

다중 채널 구성에 대한 자세한 정보는 채널 문서.

다중 환경 및 병합 요청 배포와 함께 완전한 구성:

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

수동 승인 필요 production 배포:

__CAPGO_KEEP_0__ Branch-Based Deployment Strategy

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

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__ : __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ __CAPGO_KEEP_2__ __CAPGO_KEEP_3__

# 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

__CAPGO_KEEP_0 CAPGO_KEEP_1__

__CAPGO_KEEP_0 : CAPGO_KEEP_1__

__CAPGO_KEEP_0__ : __CAPGO_KEEP_1__API : __CAPGO_KEEP_1__
__CAPGO_KEEP_0__ : __CAPGO_KEEP_1____CAPGO_KEEP_0__ : __CAPGO_KEEP_1__
__CAPGO_KEEP_0__ : __CAPGO_KEEP_1__: __CAPGO_KEEP_0__ 변수 접근을 유지 관리자만으로 제한하세요
정규 로테이션: API 토큰을 정기적으로 회전하세요

안전한 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"

모니터링 및 알림

슬랙 통합

pipeline에 슬랙 알림을 추가하세요:

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

Build artifacts를 찾을 수 없습니다:

# List build outputs
debug_build:
  script:
    - ls -la dist/
    - find dist/ -type f -name "*.js" -o -name "*.html"

Debug 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__ for advanced deployment scenarios
설정 암호화 secure deployments를 위해
설정 업데이트 동작 업데이트가 적용되는 방식을 커스터마이즈하기 위해

GitLab CI/CD와의 통합을 통해, Capgo 배포를 자동화하고, 사용자에게 안정적이고 일관된 업데이트를 제공할 수 있습니다.