Costruzioni di build Android con GitLab CI

La configurazione del CI/CD per le app Capacitor può essere complessa e richiede molto tempo. Ecco cosa devi sapere:

Prerequisiti

Prima di iniziare, dovrai configurare:

Un account GitLab con accesso amministrativo
La tua app già pubblicata su Google Play Store con firma corretta
Chiave di firma Android e file keystore
Progetto di Google Cloud Console con Play Store API abilitato
Account di servizio con permessi corretti
Comprensione dei flussi di lavoro di GitLab CI/CD
Conoscenza della configurazione di Fastlane
Tempo per mantenere e debuggare il pipeline

Capgo Costruisci per CI/CD da Capgo

Saltare la manutenzione di Fastlane, Gradle runner, keystore e upload-script Capgo Costruisci Esegue costruzioni native Android firmate da Android direttamente dal tuo pipeline CI/CD esistente:

Funziona con il tuo pipeline: Attiva Capgo Build da GitLab CI, GitHub Actions, Jenkins o script locali dopo la tua build web e npx cap sync.
Sottoscrizione da segreti CI: Mantieni le chiavi Android, gli alias chiave, le password e il file JSON del servizio account Play Console nei tuoi segreti CI.
Nessuna manutenzione del runner nativo: Capgo Build fornisce ambienti di build Android mantenuti, quindi non devi gestire SDK immagini, problemi di cache Gradle o Fastlane lanes.
Articoli e sottoscrizione: Scarica gli articoli firmati per la QA o invia release build attraverso il Capgo CLI.

Prenotazione

I piani Capgo iniziano a $12/mese
Includono aggiornamenti OTA e circa 15 build native al mese
I minuti di build extra sono fatturati per minuto attraverso crediti

Configura Capgo per l'ambiente di integrazione/compilazione

Guida di configurazione manuale

Ecco cosa devi fare:

I passaggi da seguire nel post

Copia i file Fastlane
Memorizza i tuoi segreti nei segreti GitLab crittografati
Creazione e memorizzazione della chiave di servizio Google Play
Memorizza la tua chiave di firma Android
Configura il tuo workflow GitLab .yml file

1. Copia i file Fastlane

Fastlane è una libreria Ruby creata per automatizzare le attività comuni di sviluppo mobile. Utilizzando Fastlane, puoi configurare percorsi personalizzati che raggruppano una serie di 'azioni' che eseguono compiti che normalmente eseguiresti utilizzando Android Studio. Con Fastlane puoi fare molto, ma per gli scopi di questo tutorial, utilizzeremo solo una manciata di azioni di base.

Creare un cartello Fastlane alla radice del tuo progetto e copia i seguenti file: 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

Salvare i tuoi segreti in variabili GitLab CI/CD

GitLab fornisce una modalità per memorizzare le variabili CI/CD crittografate, simile a GitHub’s repository secrets. Per memorizzare le informazioni sensibili in modo sicuro.

Vai alle impostazioni del tuo progetto GitLab.
Naviga a CI/CD > Variabili
Aggiungi le seguenti variabili:

ANDROID_KEYSTORE_FILE: il file base64 codificato .jks o .keystore utilizzato per firmare le tue build Android. Questo sarà il file keystore associato alla tua chiave di caricamento (se si utilizza Play App Signing), o la chiave di firma dell'applicazione.
KEYSTORE_KEY_PASSWORD: la password associata al file keystore
KEYSTORE_KEY_ALIAS: l'alias del keystore
KEYSTORE_STORE_PASSWORD: la password della chiave privata
DEVELOPER_PACKAGE_NAME: il tuo ID di app Android come ad esempio com.example.app
PLAY_CONFIG_JSON: La chiave JSON del servizio account codificata in base64.

Creazione di una chiave del servizio Google Play

Per generare il PLAY_CONFIG_JSON segreto, segui questi passaggi:

Vai al Console di Google Cloud
Crea un nuovo progetto o seleziona uno esistente
Abilita il Google Play Android Developer API
Crea un account del servizio:
- Vai a “IAM & Amministrazione” > “Account del servizio”
- Clicca su “Crea Account del Servizio”
- Dagli un nome e una descrizione
- Clicca su “Crea e continua”
- Ssaltare l'assegnazione del ruolo e clicca su “Fatto”
Genera una chiave JSON:
- Trova il tuo account di servizio nella lista
- Clicca sul menu a tre punti > “Gestisci chiavi”
- Clicca su “Aggiungi chiave” > “Crea nuova chiave”
- Scegli il formato JSON
- Clicca su “Crea”
Concedi all'account di servizio l'accesso al tuo app nel Console di gioco:
- Vai a Console di gioco
- Naviga a “Utenti e autorizzazioni”
- Clicca su “Invita nuovi utenti”
- Inserisci l'indirizzo email del servizio (termina con @*.iam.gserviceaccount.com)
- Concedi la “Concessione di rilascio in produzione”
- Clicca su “Invita utente”

Converti la chiave JSON in base64:

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

Aggiungi la stringa base64 codificata come PLAY_CONFIG_JSON variabile in GitLab

Configura la tua pipeline CI/CD di GitLab

Crea un file .gitlab-ci.yml nella radice del tuo progetto per definire la tua pipeline CI/CD. Ecco un esempio di come puoi strutturare la tua 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

Avvia la Pipeline

Quando pubblichi un nuovo tag nel tuo repository di GitLab, la pipeline CI/CD di GitLab si attiverà automaticamente, costruendo e distribuendo la tua app Android tramite Fastlane.

Assicurati di adattare le percorso e le dipendenze in base alla struttura e alle esigenze del tuo progetto. Questa configurazione ti aiuterà a automatizzare la distribuzione della tua app Android su GitLab CI/CD.

Conclusion

Configurando GitLab CI/CD con l'immagine Docker mingc/android-build-box, puoi automatizzare il processo di costruzione dell'app Android, rendendo il tuo workflow di sviluppo più efficiente e affidabile. Questa automazione ti consente di dedicare più tempo alle parti centrali dello sviluppo dell'app, aiutandoti a consegnare app Android di alta qualità in modo più efficiente.

Automatic Capacitor Android build with GitLab