Pembangunan Android Otomatis dengan GitLab CI

Mengatur CI/CD untuk aplikasi Capacitor dapat kompleks dan memakan waktu lama. Berikut ini yang perlu Anda ketahui:

Persyaratan

Sebelum memulai, Anda perlu mengatur:

Akun GitLab dengan akses admin
Aplikasi Anda sudah dipublikasikan di Google Play Store dengan tanda tangan yang tepat
Kunci dan file keystore Android
Project Google Cloud Console dengan API Play Store diaktifkan
Akun layanan dengan izin yang tepat
Pengertian tentang alur kerja GitLab CI/CD
Pengetahuan tentang konfigurasi Fastlane
Waktu untuk menjaga dan memperbaiki pipeline

Capgo Bangun untuk CI/CD oleh Capgo

Lepaskan Fastlane, runner Gradle, keystore, dan skrip unggah Capgo Bangun menghasilkan bangun native Android yang ditandatangani secara otomatis dari pipeline CI/CD yang sudah ada:

Bekerja dengan pipeline Anda: Aktifkan Capgo Pembangunan dari GitLab CI, GitHub Aksi, Jenkins, atau skrip lokal setelah pembangunan web Anda dan npx cap sync.
Tanda Tangan dari Rahasia CI: Simpan keystore Android, alias kunci, kata sandi, dan JSON layanan Console Play di rahasia CI Anda sendiri.
Tidak ada perawatan penggunaan runner asli: Capgo Pembangunan menyediakan lingkungan pembangunan Android yang dipelihara, sehingga Anda tidak perlu mengelola SDK gambar, masalah cache Gradle, atau jalur Fastlane.
Arsip dan pengiriman: Unduh arsip yang ditandatangani untuk QA atau kirimkan rilis melalui Capgo CLI.

Pricing

Capgo rencana mulai dari $12/bulan
Termasuk pembaruan OTA dan sekitar 15 pembangunan asli per bulan
Menit pembangunan tambahan dikenakan biaya per menit melalui kredit

Konfigurasi Capgo untuk Dibangun dalam CI/CD

Panduan Konfigurasi Manual

Ini yang perlu Anda lakukan:

Langkah-langkah untuk diikuti dalam postingan

Mengcopy file Fastlane
Menyimpan rahasia Anda di GitLab rahasia yang dienkripsi
Membuat dan menyimpan kunci layanan Google Play
Menyimpan kunci tanda tangan Android
Konfigurasi alur kerja GitLab Anda .yml file

1. Mengcopy file Fastlane

Fastlane adalah sebuah library Ruby yang dibuat untuk mengotomatisasi tugas pengembangan mobile yang umum. Dengan menggunakan Fastlane, Anda dapat mengonfigurasi jalur kustom yang dapat menggabungkan serangkaian aksi yang melakukan tugas-tugas yang biasanya Anda lakukan menggunakan Android Studio. Anda dapat melakukan banyak hal dengan Fastlane, tetapi untuk tujuan tutorial ini, kita hanya akan menggunakan beberapa aksi inti.

Buat folder Fastlane di root project Anda dan copy file-file berikut: 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

Menyimpan Rahasia Anda di Variabel GitLab CI/CD

GitLab menyediakan cara untuk menyimpan variabel CI/CD yang dienkripsi, mirip dengan GitHub’s rahasia repository.

Pergi ke pengaturan proyek GitLab Anda.
Navigasikan ke CI/CD > Variabel
Tambahkan variabel berikut:

ANDROID_KEYSTORE_FILE: file base64 yang di-encode .jks atau .keystore file yang digunakan untuk menandatangani bangun Android Anda. Ini akan sama dengan file keystore yang terkait dengan kunci unggah (jika menggunakan Play App Signing), atau kunci penandatangan aplikasi Anda.
KEYSTORE_KEY_PASSWORD: kata sandi yang terkait dengan file keystore
KEYSTORE_KEY_ALIAS: alias keystore
KEYSTORE_STORE_PASSWORD: kata sandi kunci pribadi
DEVELOPER_PACKAGE_NAME: ID aplikasi Android Anda seperti com.example.app
PLAY_CONFIG_JSON: Kunci JSON akun layanan yang di-encode base64.

Membuat Akun Layanan Google Play

Untuk menghasilkan kunci rahasia, ikuti langkah-langkah berikut: PLAY_CONFIG_JSON Buka halaman

Google Cloud Console Buat proyek baru atau pilih proyek yang sudah ada
Aktifkan Google Play Android Developer __CAPGO_KEEP_0__
Enable the Google Play Android Developer API
Buka “IAM & Admin” > “Service Accounts”
- Klik “Create Service Account”
- Berikan nama dan deskripsi
- untuk akun layanan
- Klik "Buat dan Lanjutkan"
- Lebihkan pengaturan peran dan klik "Selesai"
Generate kunci JSON:
- Cari akun layanan Anda di daftar
- Klik menu tiga titik > "Kelola kunci"
- Klik "Tambah Kunci" > "Buat kunci baru"
- Pilih format JSON
- Klik "Buat"
Berikan akses akun layanan ke aplikasi Anda di Console Play:
- Pergi ke Console Play
- Navigasikan ke "Pengguna dan izin"
- Klik ‘Undang pengguna baru’
- Masukkan alamat email akun layanan (akhir dengan @*.iam.gserviceaccount.com)
- Berikan izin ‘Rilis ke produksi’
- Klik ‘Undang pengguna’

Konversi kunci JSON ke base64:

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

Tambahkan string base64 yang dikodekan sebagai PLAY_CONFIG_JSON variabel di GitLab

Atur Pipa CI/CD GitLab Anda

Buat file .gitlab-ci.yml di root proyek Anda untuk menentukan pipa CI/CD Anda. Berikut adalah contoh struktur pipa Anda:


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

Aktifkan Pipa

Saat Anda mengirimkan tag baru ke repository GitLab Anda, GitLab CI/CD akan secara otomatis mengaktifkan pipa yang telah ditentukan, yang akan membangun dan mendeploykan aplikasi Android menggunakan Fastlane.

Pastikan untuk menyesuaikan jalur dan dependensi sesuai dengan struktur dan kebutuhan proyek Anda. Pengaturan ini akan membantu Anda mengotomatisasi proses mendeploy aplikasi Android Anda di GitLab CI/CD.

Kesimpulan

Dengan mengonfigurasi GitLab CI/CD dengan gambar Docker mingc/android-build-box, Anda dapat mengotomatisasi proses pembangunan aplikasi Android, sehingga membuat alur kerja pengembangan Anda lebih efisien dan dapat diandalkan. Otomatisasi ini membebaskan waktu Anda untuk fokus pada aspek inti pengembangan aplikasi, sehingga membantu Anda mengirimkan aplikasi Android berkualitas tinggi lebih efisien.

Pembangunan Otomatis Capacitor Android dengan GitLab