GitLab CI를 사용한 자동 안드로이드 빌드

CI/CD를 위한 Capacitor 앱 설정은 복잡하고 시간이 많이 걸립니다. 이에 대해 알아야 할 내용은 다음과 같습니다.

준비 사항

시작하기 전에 다음을 설정해야 합니다.

관리자 권한이 있는 GitLab 계정
Google Play Store에 이미 올바른 서명으로 게시된 앱이 있습니다.
Android 서명 키와 키스토어 파일
Play Store API이 활성화된 Google Cloud Console 프로젝트
적절한 권한이 있는 서비스 계정
GitLab CI/CD 워크플로우 이해
Fastlane 구성에 대한 지식
pipeline 유지 및 디버깅에 소요되는 시간

Capgo CI/CD를 위한 빌드 (Translation note: - "Build" is translated to "" - "for" is implied by the context - "CI/CD" is translated to "" - "by" is implied by the context - "Capgo" is left as is, as it's a placeholder)

Fastlane, Gradle 런너, 키스토어 및 업로드 스크립트 유지 관리를 생략합니다. Capgo 빌드 Capgo는 현재 CI/CD pipeline에서 사용 중인 GitLab를 통해 signed native Android 빌드를 자동으로 생성합니다.

이미 존재하는 CI/CD pipeline에서 signed native Android 빌드를 실행합니다.:: GitLab CI, GitHub Actions, Jenkins, 또는 로컬 스크립트에서 Capgo 빌드를 트리거하세요. npx cap sync.
CI 비밀에서 서명합니다.: Android 키 스토어, 키 별칭, 비밀번호, 및 Play Console 서비스 계정 JSON을 CI 비밀에서 유지하세요.
자연화된 빌드 환경 유지 관리가 필요하지 않습니다.: Capgo 빌드는 유지 관리된 Android 빌드 환경을 제공하므로, SDK 이미지를 관리하거나 Gradle 캐시 문제, 또는 Fastlane 경로를 관리할 필요가 없습니다.
아티팩트 및 제출: QA를 위해 서명된 아티팩트를 다운로드하거나 Capgo CLI를 통해 릴리스 빌드를 제출하세요.

가격

: Capgo 플랜은 $12/월부터 시작됩니다.
: OTA 업데이트와 약 15개의 네이티브 빌드를 포함합니다.
추가 빌드 분량은 분당 크레딧으로 청구됩니다.

: CI/CD에서 Capgo 빌드를 설정하세요.

설치 가이드

다음과 같은 작업이 필요합니다:

이 포스트에서 따르는 단계

Fastlane 파일 복사
GitLab 암호화 비밀 저장
GitLab 암호화 비밀 저장
Google Play 서비스 계정 키 생성 및 저장
Android 서명 키 저장

GitLab 워크플로우 .yml 파일 설정

1. Fastlane 파일 복사

프로젝트의 루트 폴더에 Fastlane 폴더를 생성하고 다음 파일을 복사하십시오: Fastlane

default_platform(:android)

KEYSTORE_KEY_ALIAS = ENV["KEYSTORE_KEY_ALIAS"]
KEYSTORE_KEY_PASSWORD = ENV["KEYSTORE_KEY_PASSWORD"]
KEYSTORE_STORE_PASSWORD = ENV["KEYSTORE_STORE_PASSWORD"]

platform :android do
    desc "Deploy a beta version to the Google Play"
    private_lane :verify_changelog_exists do |version_code: |
      changelog_path = "android/metadata/en-US/changelogs/#{version_code}.txt"
      UI.user_error!("Missing changelog file at #{changelog_path}") unless File.exist?(changelog_path)
      UI.message("Changelog exists for version code #{version_code}")
    end

    private_lane :verify_upload_to_staging do |version_name: |
      UI.message "Skipping staging verification step"
    end
    lane :beta do
				keystore_path = "#{Dir.tmpdir}/build_keystore.keystore"
				File.write(keystore_path, Base64.decode64(ENV['ANDROID_KEYSTORE_FILE']))
				json_key_data = Base64.decode64(ENV['PLAY_CONFIG_JSON'])
				previous_build_number = google_play_track_version_codes(
					package_name: ENV['DEVELOPER_PACKAGE_NAME'],
					track: "internal",
					json_key_data: json_key_data,
				)[0]

				current_build_number = previous_build_number + 1
				sh("export NEW_BUILD_NUMBER=#{current_build_number}")
        gradle(
          task: "clean bundleRelease",
          project_dir: 'android/',
          print_command: false,
          properties: {
            "android.injected.signing.store.file" => "#{keystore_path}",
            "android.injected.signing.store.password" => "#{KEYSTORE_STORE_PASSWORD}",
            "android.injected.signing.key.alias" => "#{KEYSTORE_KEY_ALIAS}",
            "android.injected.signing.key.password" => "#{KEYSTORE_KEY_PASSWORD}",
						'versionCode' => current_build_number
          })
        upload_to_play_store(
					package_name: ENV['DEVELOPER_PACKAGE_NAME'],
					json_key_data: json_key_data,
          track: 'internal',
          release_status: 'completed',
          skip_upload_metadata: true,
          skip_upload_changelogs: true,
          skip_upload_images: true,
          skip_upload_screenshots: true,
        )
    end
    lane :build do
      gradle(
        task: "clean bundleRelease",
        project_dir: 'android/',
        print_command: false,
        properties: {
          "android.injected.signing.store.file" => "#{keystore_path}",
          "android.injected.signing.store.password" => "#{KEYSTORE_STORE_PASSWORD}",
          "android.injected.signing.key.alias" => "#{KEYSTORE_KEY_ALIAS}",
          "android.injected.signing.key.password" => "#{KEYSTORE_KEY_PASSWORD}",
        })
    end
    lane :prod_release do
      build_gradle = File.read("../android/app/build.gradle")

      verify_changelog_exists(version_code: build_gradle.match(/versionCode (\d+)/)[1])
      verify_upload_to_staging(version_name: build_gradle.match(/versionName '([\d\.]+)'/)[1])

      supply(
        track_promote_to: 'beta',
        skip_upload_apk: true,
        skip_upload_aab: true,
        skip_upload_metadata: false,
        skip_upload_changelogs: false,
        skip_upload_images: false,
        skip_upload_screenshots: false
      )
    end
end

프로젝트의 루트 디렉토리에 Fastlane 폴더를 생성하고 다음 파일을 복사하십시오: Fastlane

GitLab은 암호화 된 CI/CD 변수를 저장하는 방법을 제공합니다. GitHub의 저장소 비밀과 유사합니다._sensitive 정보를 안전하게 저장하려면.

GitLab 프로젝트의 설정으로 이동하세요.
CI/CD > 변수로 이동하세요.
다음 변수를 추가하세요:

ANDROID_KEYSTORE_FILE: base64-인코딩 .jks 또는 .keystore 파일을 사용하여 Android 빌드를 서명하는 키 스토어 파일입니다. Play App Signing을 사용하는 경우 업로드 키와 관련된 키 스토어 파일 또는 앱 서명 키입니다.
KEYSTORE_KEY_PASSWORD: 키 스토어 파일과 관련된 암호입니다.
KEYSTORE_KEY_ALIAS: 키 스토어 별칭입니다.
KEYSTORE_STORE_PASSWORD: 키 스토어의 개인 키 암호입니다.
DEVELOPER_PACKAGE_NAME: Android 앱 ID와 유사한 com.example.app과 같은 개발자 패키지 이름입니다.
PLAY_CONFIG_JSON: 서비스 계정 키 JSON을 base64 인코딩한 것입니다.

Google Play 서비스 계정 키를 생성하는 방법

생성하려면 다음 단계를 따르세요. PLAY_CONFIG_JSON 비밀번호를 생성하려면 다음 단계를 따르세요.

가서 새로운 프로젝트를 생성하거나 기존 프로젝트를 선택하세요.
Google Play Android Developer를 활성화하세요.
구글 플레이 안드로이드 개발자에게 API을 활성화하세요.
‘IAM & Admin’ > ‘Service Accounts’로 이동하세요.
- ‘서비스 계정 생성’ 버튼을 클릭하세요.
- 이름과 설명을 입력하세요.
- ‘생성 및 계속’ 버튼을 클릭하세요.
- Google Play Android Developer
- 역할 assign을 생략하고 "Done" 버튼을 클릭하세요.
JSON 키 생성
- 서비스 계정 찾기
- 메뉴의 세 점을 클릭하고 > "키 관리"
- Click “새 키 추가” > “새 키 생성”
- JSON 형식 선택
- Click "Create"
애플리케이션에 대한 액세스 권한을 Play Console에서 서비스 계정에 부여하십시오.
- 가기 Play Console
- 사용자 및 권한으로 이동하세요
- 새 사용자 초대하기
- 서비스 계정 이메일을 입력하세요 (*.iam.gserviceaccount.com로 끝나야 함)
- “제품 출시 허용” 권한을 부여하세요
- “사용자 초대” 버튼을 클릭하세요

JSON 키를 base64로 변환하세요:

base64 -i path/to/your/service-account-key.json | pbcopy

GitLab에 base64로 인코딩된 문자열을 추가하세요 PLAY_CONFIG_JSON 변수

GitLab CI/CD Pipeline 설정

프로젝트 루트에 .gitlab-ci.yml 파일을 생성하여 CI/CD pipeline을 정의하세요. 아래는 pipeline 구조 예시입니다.


image: mingc/android-build-box:latest

stages:
  - build
  - upload_to_capgo
  - build_and_upload_android

build:
  stage: build
  tags:
    - saas-linux-xlarge-amd64
  cache:
    - key:
        files:
          - bun.lockb
      paths:
        - .node_modules/
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - node_modules/
      - dist/
  only:
    - master

upload_to_capgo:
  stage: upload_to_capgo
  tags:
    - saas-linux-xlarge-amd64
  script:
    - npx @capgo/cli@latest bundle upload -a $CAPGO_TOKEN -c dev
  dependencies:
    - build
  when: manual
  only:
    - master

build_and_upload_android:
  tags:
    - saas-linux-xlarge-amd64
  stage:    build_and_upload_android
  cache:
    - key:
        files:
          - android/gradle/wrapper/gradle-wrapper.properties
      paths:
        - ~/.gradle/caches/
  script:
    - npx cap sync android
    - npx cap copy android
    - bundle exec fastlane android beta # We do create a tag for the build to trigger XCode cloud builds
  dependencies:
    - build
  when: manual
  only:
    - master

pipeline 실행

GitLab 저장소에 새로운 태그를 푸시할 때마다 GitLab CI/CD는 정의된 pipeline을 자동으로 실행하여 Android 앱을 Fastlane을 통해 빌드 및 배포합니다.

프로젝트 구조 및 요구 사항에 따라 경로 및 의존성을 조정하세요. 이 설정은 GitLab CI/CD를 통해 Android 앱의 자동 배포를 도와줍니다.

결론

GitLab CI/CD를 mingc/android-build-box Docker 이미지를 사용하여 구성하면 Android 앱 빌드 프로세스를 자동화할 수 있습니다. 개발 워크플로우를 효율적이고 신뢰할 수 있는 것으로 만들 수 있습니다. 이 자동화는 개발의 핵심 측면에 집중할 수 있도록 시간을 절약하고, 결국 Android 앱을 더 효율적으로 높은 품질로 제공할 수 있습니다.

Automatic Capacitor Android 빌드와 GitLab에서 계속 진행하세요.

GitLab CI/CD를 사용하는 경우 Automatic Capacitor Android 빌드와 GitLab CI/CD 자동화 계획을 위해 GitLab CI/CD와 연결하세요. Capgo CI/CD Capgo Native Builds Capgo 원시 빌드 Capgo Native Builds Capgo Native Builds Capgo Native Builds __CAPGO_KEEP_0__ Native Builds CI/CD 통합 구현 세부 사항에 대해 GitHub 액션 통합 GitHub 액션 통합 구현 세부 사항에 대해

자동 Capacitor 안드로이드 빌드와 GitLab