메뉴로 이동
Capgo - Capacitor 앱의 Live Updates Capgo

GitLab CI/CD 통합

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

필수 조건

제목 ‘필수 조건’

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

  • GitLab 계정과 프로젝트 저장소
  • Capgo 계정과 앱이 구성된 상태
  • 프로젝트에 Node.js 및 npm/yarn이 구성된 상태

GitLab CI/CD 설정

설정 제목: GitLab CI/CD 설정

1단계: 환경 변수 구성

설정 제목: 1단계: 환경 변수 구성

첫 번째로, GitLab 프로젝트에서 필요한 변수를 설정하세요:

  1. GitLab 프로젝트로 이동하세요
  2. 가장 먼저 설정 → CI/CD → 변수
  3. 다음과 같은 변수를 추가하세요:
변수 이름값보호가려진
CAPGO_TOKENCapgo API 토큰을 보호합니다.✅ 예✅ 예

Simple

간단한 방법

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

고급

고급 설정

기능 branch 배포

기능 branch 배포

기능 branch를 테스트 채널에 배포하여 검토 및 테스트합니다.

# 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_KEEP_0__의 암호화 기능을 사용 중이라면, CI/CD 환경에서 개인 키를 안전하게 저장해야 합니다. Capgo’s encryption feature개인 키를 GitLab 변수에 추가하세요.

터미널 창 클립보드에 복사 __CAPGO_KEEP_0__

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

이 콘텐츠를 추가하여 CAPGO_PRIVATE_KEY GitLab 프로젝트 변수 (보호 및 가려진) 에서 이 콘텐츠를 추가하고 pipeline에서 사용하십시오:

# 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

멀티 채널 구성

section

생산 환경에 대한 자세한 정보는 채널 문서.

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

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

Branch-Based 배포 전략

제목 ‘Branch-Based 배포 전략’

적절한 채널로 자동으로 다른 branch를 배포:

# 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. __CAPGO_KEEP_0__ 변수를 감추고 보호하세요: Always mark API tokens as protected and masked
  2. : 프로덕션 배포 시 보호 변수를 사용하세요접근 제어
  3. : 유지관리자만 변수 접근을 제한하세요정기적인 회전
  4. : __CAPGO_KEEP_0__ 변수를 정기적으로 회전하세요API tokens

안전한 PipeLine 설정

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

빌드 아티팩트가 없습니다:

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

Debug Pipeline

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 배포를 자동화하고 모바일 앱 사용자에게 일관된, 신뢰할 수 있는 업데이트를 보장할 수 있습니다.

GitLab CI/CD 통합에서 계속 진행하기

GitLab CI/CD 통합에서 계속 진행하기

GitLab CI/CD 통합을 사용하여 CI/CD 자동화 계획을 수립하고 __CAPGO_KEEP_0__ CI/CD와 연결합니다. Capgo CI/CD 제품 워크플로우에 대한 Capgo CI/CD를 위해 Capgo 네이티브 빌드 Capgo CI/CD를 위한 제품 워크플로우 Capgo 통합 Capgo 통합을 위한 제품 워크플로우 CI/CD 통합 CI/CD 통합에 대한 구현 세부 정보 GitHub 액션 통합 GitHub 액션 통합에 대한 구현 세부 정보