컨텐츠로 바로가기
Capgo - Capacitor 앱의 실시간 업데이트 Capgo

GitHub 액션 통합

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

사전 요구 사항

‘사전 요구 사항’이라는 제목을 가진 섹션

GitHub Actions 통합을 설정하기 전에 다음을 확인하십시오:

  • GitHub 저장소가 앱의 소스 code를 포함하고 있어야 합니다.
  • Capgo 계정이 앱이 구성된 상태여야 합니다.
  • Node.js 및 npm/yarn이 프로젝트에 구성되었습니다.
  • GitHub Actions가 저장소에 활성화되었습니다.

GitHub 비밀을 설정하는 중입니다.

GitHub 비밀을 설정하는 방법

1단계: 저장소 비밀을 구성하세요.

1단계: 저장소 비밀을 구성하는 방법

GitHub 저장소에 필요한 비밀을 설정하세요.

  1. GitHub 저장소로 이동하세요.
  2. 이동 설정 → 비밀 및 변수 → 작업
  3. Click 새로운 저장소 비밀 및 다음을 추가하세요.
비밀 이름값
CAPGO_TOKENCapgo API 토큰을 얻으세요.

간단한 프로덕션 배포

간단한 프로덕션 배포 섹션

main branch로 푸시하는 모든 경우에 프로덕션으로 배포하는 기본 설정부터 시작하세요:

# Simple GitHub Actions Workflow for Capgo Live Updates
name: Deploy to Capgo


on:
  push:
    branches:
      - main


jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6


      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - name: Install, test and build
        run: |
          npm ci
          npm run test
          npm run build


      - name: Deploy to Capgo
         run: |
           npm install -g @capgo/cli
           npx @capgo/cli bundle upload --channel production
          env:
            CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
           # For encrypted uploads, add: --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

고급 다중 채널 구성

고급 다중 채널 구성 섹션

기능 branch 배포

기능 branch 배포 섹션

기능 branch를 테스트하기 위한 임시 채널로 배포하세요:

# Feature branch deployment
name: Deploy Feature Branch to Capgo


on:
  push:
    branches:
      - 'feature/**'


jobs:
  deploy-feature:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - run: |
          npm ci
          npm run test
          npm run build


      - name: Deploy to feature channel
        run: |
          CHANNEL_NAME=$(echo "${{ github.ref_name }}" | sed 's/[^a-zA-Z0-9]/-/g' | tr '[:upper:]' '[:lower:]')
          npm install -g @capgo/cli
          npx @capgo/cli channel create $CHANNEL_NAME --apikey ${{ secrets.CAPGO_TOKEN }} || true
                     npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel $CHANNEL_NAME

암호화 사용

암호화 사용 섹션

만약 __CAPGO_KEEP_0__의 암호화 기능을 사용 중이라면 Capgo의 개인 키를 안전하게 CI/CD 환경에 저장해야 합니다.암호화 키를 설정한 후

개인 키를 __CAPGO_KEEP_0__의 비밀을 추가하세요: 터미널 창 locally, add your private key to GitHub secrets:

__CAPGO_KEEP_0__ 저장소 비밀에 이 내용을 추가하세요. 그리고 워크플로우에서 사용하세요:
# Display your private key content (copy this output)
cat .capgo_key_v2

주의 CAPGO_PRIVATE_KEY GitHub

# Deploy with encryption
- name: Deploy to Capgo with Encryption
  run: |
    npm install -g @capgo/cli
    npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}" --channel production

다중 채널 구성

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

채널 문서 개발, pull request 및 프로덕션 배포와 같은 완전한 워크플로우:.

클립보드에 복사

# Complete multi-environment workflow
name: Deploy to Capgo


on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]


jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - run: |
          npm ci
          npm run test
          npm run build


      - uses: actions/upload-artifact@v6
        with:
          name: dist
          path: dist/


  deploy-development:
    if: github.ref == 'refs/heads/develop'
    needs: build
    runs-on: ubuntu-latest
    environment: development
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist/


      - run: |
          npm install -g @capgo/cli
          npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel development


  deploy-pr:
    if: github.event_name == 'pull_request'
    needs: build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist/


      - name: Deploy to PR channel
        run: |
          CHANNEL_NAME="pr-${{ github.event.number }}"
          npm install -g @capgo/cli
          npx @capgo/cli channel create $CHANNEL_NAME --apikey ${{ secrets.CAPGO_TOKEN }} || true
          npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel $CHANNEL_NAME


      - name: Comment PR
        uses: actions/github-script@v7
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `🚀 This PR has been deployed to Capgo channel: \`pr-${{ github.event.number }}\`\n\nTo test this update in your app, configure it to use this channel. [Learn how to configure channels →](/docs/live-updates/channels/#configuring-the-channel-in-your-app)`
            })


  deploy-production:
    if: github.ref == 'refs/heads/main'
    needs: build
    runs-on: ubuntu-latest
    environment: production
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist/


      - run: |
          npm install -g @capgo/cli
          npx @capgo/cli bundle upload --apikey ${{ secrets.CAPGO_TOKEN }} --channel production

제목: "채널 제거"

브랜치가 삭제될 때 자동으로 채널을 정리합니다.

클립보드에 복사

name: Cleanup Feature Channels


on:
  delete:


jobs:
  cleanup:
    runs-on: ubuntu-latest
    if: github.event.ref_type == 'branch' && startsWith(github.event.ref, 'feature/')
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: '24'


      - name: Delete Capgo channel
        run: |
          CHANNEL_NAME=$(echo "${{ github.event.ref }}" | sed 's/[^a-zA-Z0-9]/-/g' | tr '[:upper:]' '[:lower:]')
          npm install -g @capgo/cli
          npx @capgo/cli channel delete $CHANNEL_NAME --apikey ${{ secrets.CAPGO_TOKEN }} || true

제목: "보안 및最佳 관행"

환경 보호 규칙

__CAPGO_KEEP_0__

환경 보호 규칙 섹션

GitHub에서 환경 보호 규칙을 설정하세요.

  1. 가기 설정 → 환경 repository에서
  2. 환경 만들기: development, staging, production
  3. 생산 환경에 추가:
    • 필수 검토자: 배포를 승인해야 하는 팀원 추가
    • 대기 시간: 배포 전 지연 시간 추가 (선택 사항)
    • 배포 branch: Restrict to main branch만

보안 비밀 관리

보안 비밀 관리

환경에 따라 비밀을 사용하세요:

# Use different secrets per environment
deploy-production:
  environment: production
  steps:
    - name: Deploy to Production
      run: |
        npx @capgo/cli bundle upload \
          --apikey ${{ secrets.CAPGO_PROD_TOKEN }} \
          --app ${{ secrets.CAPGO_PROD_APP_ID }} \
          --channel production

모니터링 및 알림

모니터링 및 알림

슬랙 통합

슬랙 통합

워크플로에 슬랙 알림을 추가하세요:

name: Deploy with Notifications


jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      # ... deployment steps


      - name: Notify Slack on Success
        if: success()
        uses: 8398a7/action-slack@v3
        with:
          status: success
          text: '✅ Capgo deployment successful!'
          fields: repo,message,commit,author,action,eventName,ref,workflow
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}


      - name: Notify Slack on Failure
        if: failure()
        uses: 8398a7/action-slack@v3
        with:
          status: failure
          text: '❌ Capgo deployment failed!'
          fields: repo,message,commit,author,action,eventName,ref,workflow
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

디스코드 통합

디스코드 통합

디스코드로 알림을 보냅니다:

- name: Discord notification
  if: always()
  uses: Ilshidur/action-discord@master
  with:
    args: |
      Capgo deployment ${{ job.status }}!
      App: ${{ secrets.CAPGO_APP_ID }}
      Channel: ${{ github.ref_name }}
      Commit: ${{ github.sha }}
  env:
    DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}

이메일 알림

이메일 알림

이메일 알림을 설정합니다:

- name: Send email notification
  if: failure()
  uses: dawidd6/action-send-mail@v3
  with:
    server_address: smtp.gmail.com
    server_port: 465
    username: ${{ secrets.EMAIL_USERNAME }}
    password: ${{ secrets.EMAIL_PASSWORD }}
    subject: 'Capgo Deployment Failed - ${{ github.repository }}'
    to: team@yourcompany.com
    from: ci-cd@yourcompany.com
    body: |
      Deployment failed for ${{ github.repository }}
      Branch: ${{ github.ref_name }}
      Commit: ${{ github.sha }}
      Workflow: ${{ github.workflow }}

문제 해결

문제 해결

디버그 워크플로우

Debug Workflow

문제를 해결하기 위해 디버깅 단계를 추가하세요:

- name: Debug environment
  run: |
    echo "Node version: $(node --version)"
    echo "NPM version: $(npm --version)"
    echo "Working directory: $(pwd)"
    echo "Files in dist/: $(ls -la dist/ || echo 'No dist directory')"
    echo "Environment variables:"
    env | grep -E "(GITHUB_|CAPGO_)" | sort


- name: Test Capgo CLI
  run: |
    npx @capgo/cli --version
    npx @capgo/cli app debug --apikey ${{ secrets.CAPGO_TOKEN }} --app ${{ secrets.CAPGO_APP_ID }}

일반적인 문제와 해결책

일반적인 문제와 해결책

“CAPGO_TOKEN not found”라는 오류로 Workflow가 실패합니다:

- name: Verify secrets
  run: |
    if [ -z "${{ secrets.CAPGO_TOKEN }}" ]; then
      echo "ERROR: CAPGO_TOKEN secret is not set"
      exit 1
    fi
    echo "CAPGO_TOKEN is set (length: ${#CAPGO_TOKEN})"
  env:
    CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}

빌드 아티팩트가 존재하지 않습니다:

- name: Debug artifacts
  run: |
    echo "Checking for build artifacts..."
    ls -la dist/ || echo "No dist directory found"
    find . -name "*.js" -o -name "*.html" | head -10

네트워크 연결 문제:

- name: Test connectivity
  run: |
    ping -c 3 api.capgo.io || echo "Ping failed"
    curl -I https://api.capgo.io/health || echo "Health check failed"

재사용 가능한 Workflow

__CAPGO_KEEP_0__/__CAPGO_KEEP_1__

프로젝트 간 일관성을 위해 재사용 가능한 워크플로를 생성하세요:

github/workflows/reusable-capgo-deploy.yml
name: Reusable Capgo Deploy


on:
  workflow_call:
    inputs:
      environment:
        required: true
        type: string
      channel:
        required: true
        type: string
    secrets:
      CAPGO_TOKEN:
        required: true
      CAPGO_APP_ID:
        required: true


jobs:
  deploy:
    runs-on: ubuntu-latest
    environment: ${{ inputs.environment }}
    steps:
      - uses: actions/checkout@v6


      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'


      - name: Install and build
        run: |
          npm ci
          npm run build


      - name: Deploy to Capgo
        run: |
          npm install -g @capgo/cli
          npx @capgo/cli bundle upload \
            --apikey ${{ secrets.CAPGO_TOKEN }} \
            --app ${{ secrets.CAPGO_APP_ID }} \
            --channel ${{ inputs.channel }}

재사용 가능한 워크플로를 사용하세요:

github/workflows/deploy.yml
name: Deploy App


on:
  push:
    branches: [main, develop]


jobs:
  deploy-dev:
    if: github.ref == 'refs/heads/develop'
    uses: ./.github/workflows/reusable-capgo-deploy.yml
    with:
      environment: development
      channel: development
    secrets:
      CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
      CAPGO_APP_ID: ${{ secrets.CAPGO_APP_ID }}


  deploy-prod:
    if: github.ref == 'refs/heads/main'
    uses: ./.github/workflows/reusable-capgo-deploy.yml
    with:
      environment: production
      channel: production
    secrets:
      CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
      CAPGO_APP_ID: ${{ secrets.CAPGO_APP_ID }}

다음 단계

__CAPGO_KEEP_0__/__CAPGO_KEEP_1__

With GitHub Actions integration, you can leverage GitHub’s powerful CI/CD platform to create sophisticated deployment workflows with built-in security, monitoring, and collaboration features for your Capgo Live Updates.