Automatisation des builds Android avec GitLab CI

La mise en place de CI/CD pour les applications Capacitor peut être complexe et chronophage. Voici ce dont vous avez besoin de savoir :

Prérequis

Avant de commencer, vous devrez configurer :

Un compte GitLab avec accès administrateur
Votre application déjà publiée sur Google Play Store avec une signature appropriée
Clé de signature Android et fichiers de clé de signature
Projet Google Cloud Console avec la mise en ligne de Google Play Store API activée
Compte de service avec les permissions appropriées
Compréhension des workflows CI/CD de GitLab
Connaissance de la configuration de Fastlane
Temps à consacrer à la maintenance et à la débogage de la pipeline

Capgo Construire pour CI/CD par Capgo

Évitez la maintenance de Fastlane, Gradle runner, clé de stockage et script d'envoi. Capgo Construire exécute des builds natifs signés Android à partir de votre pipeline CI/CD existant :

Fonctionne avec votre pipeline: Déclenchez Capgo Construire à partir de GitLab CI, GitHub Actions, Jenkins ou de scripts locaux après votre build web et npx cap sync.
Signature à partir de secrets CI: Gardez les clés de stockage Android, les alias de clés, les mots de passe et le JSON de compte de service de Google Play dans vos propres secrets CI.
Aucune maintenance de l'exécuteur natif: Capgo Construire fournit des environnements de build Android maintenus, vous n'avez donc pas à gérer les images SDK, les problèmes de cache Gradle ou les voies de Fastlane.
Artéfacts et soumission: Téléchargez les artefacts signés pour les tests de qualité ou soumettez les builds de version à travers le Capgo CLI.

Tarification

Capgo plans commencent à 12 $/mois
Inclut les mises à jour OTA et environ 15 builds natifs par mois
Les minutes de build supplémentaires sont facturées par minute par crédit

Configurer Capgo Build dans CI/CD

Guide de configuration manuelle

Voici ce que vous devez faire :

Étapes à suivre dans l'article

Copier les fichiers Fastlane
Stockez vos secrets dans les secrets GitLab chiffrés
Créer et stocker votre clé de compte de service Google Play
Stockez votre clé de signature Android
Configurer votre fichier de flux de travail .yml de GitLab.

1. Copiez les fichiers Fastlane.

Fastlane est une bibliothèque Ruby créée pour automatiser les tâches de développement mobile courantes. En utilisant Fastlane, vous pouvez configurer des « voies » personnalisées qui regroupent une série d’« actions » qui exécutent des tâches que vous effectueriez normalement à l’aide d’Android Studio. Vous pouvez faire beaucoup avec Fastlane, mais pour les besoins de ce tutoriel, nous utiliserons uniquement une poignée d’actions de base.

Créez un dossier Fastlane à la racine de votre projet et copiez les fichiers suivants : 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

Stockez vos secrets dans les variables de GitLab CI/CD.

GitLab fournit une façon de stocker des variables CI/CD chiffrées, similaires aux secrets de repository de GitHub.

Allez dans les paramètres de votre projet GitLab.
Navigatez vers CI/CD > Variables.
Ajoutez les variables suivantes :

ANDROID_KEYSTORE_FILE : le fichier base64 codé .jks ou .keystore utilisé pour signer vos builds Android. Cela sera soit le fichier clé associé à votre clé de téléversement (si vous utilisez Play App Signing), soit votre clé de signature d’application.
KEYSTORE_KEY_PASSWORD: le mot de passe associé au fichier de clé de magasin
KEYSTORE_KEY_ALIAS: l'alias de la clé de magasin
KEYSTORE_STORE_PASSWORD: le mot de passe de la clé privée
DEVELOPER_PACKAGE_NAME: votre ID d'application Android comme par exemple com.example.app
PLAY_CONFIG_JSON: Le fichier JSON de clé de compte de service encodé en base64.

Créer une clé de compte de service Google Play

Pour générer le PLAY_CONFIG_JSON secret, suivez ces étapes:

Allez sur le Console de Cloud Google
Créez un nouveau projet ou sélectionnez un projet existant
Activez le service Google Play Android Developer API
Créer un compte d'utilisateur de service :
- Allez dans « IAM & Admin » > « Comptes d'utilisateur de service »
- Cliquez sur « Créer Compte d'utilisateur de service »
- Donnez-lui un nom et une description
- Cliquez sur « Créer et Continuer »
- Omettre l'attribution de rôle et cliquez sur « Terminé »
Générer une clé JSON :
- Trouvez votre compte d'utilisateur de service dans la liste
- Cliquez sur le menu des trois points > « Gérer les clés »
- Cliquez sur « Ajouter une clé » > « Créer une nouvelle clé »
- Choisissez le format JSON
- Cliquez sur « Créer »
Accordez l'accès au compte de service à votre application dans le console de Play :
- Allez à Console de Play
- Naviguez vers « Utilisateurs et permissions »
- Cliquez sur « Inviter de nouveaux utilisateurs »
- Entrez l'adresse e-mail du compte de service (se termine par @*.iam.gserviceaccount.com)
- Accordez la permission « Lancer en production »
- Cliquez sur « Inviter l'utilisateur »

Convertissez la clé JSON en base64 :

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

Ajoutez la chaîne encodée en base64 comme PLAY_CONFIG_JSON variable dans GitLab

Configurer votre pipeline CI/CD de GitLab

Créez un fichier .gitlab-ci.yml à la racine de votre projet pour définir votre pipeline CI/CD. Voici un exemple de la structure que vous pouvez donner à votre 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

Déclencher le Pipeline

Chaque fois que vous publiez une nouvelle étiquette dans votre dépôt GitLab, GitLab CI/CD déclenchera automatiquement le pipeline défini, qui construira et déployera votre application Android à l'aide de Fastlane.

Assurez-vous de modifier les chemins et les dépendances en fonction de la structure et des besoins de votre projet. Cette configuration vous aidera à automatiser le déploiement de votre application Android sur GitLab CI/CD.

Conclusion

En configurant GitLab CI/CD avec l'image Docker mingc/android-build-box, vous pouvez automatiser le processus de construction de l'application Android, ce qui rend votre flux de développement plus efficace et fiable. Cette automatisation vous libère du temps pour vous concentrer sur les aspects essentiels du développement d'applications, ce qui vous aide à livrer des applications Android de haute qualité de manière plus efficace.

Continuez de l'Automatic Capacitor Android build avec GitLab

Si vous utilisez Automatic Capacitor Android build avec GitLab pour planifier l'automatisation de CI/CD, connectez-le à Capgo CI/CD pour le flux de travail du produit dans Capgo CI/CD, Capgo Bâtiments natifs pour le flux de travail du produit dans Capgo Bâtiments natifs, Capgo Intégrations pour le flux de travail du produit dans Capgo Intégrations, Intégration CI/CD pour le détail d'implémentation dans Intégration CI/CD, et GitHub Intégration d'actions pour le détail d'implémentation dans GitHub Intégration d'actions.

Construction automatique de l'Capacitor de l'Android avec GitLab