Construction automatique d'applications Android avec GitLab CI

La mise en place de la 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 est déjà publiée sur Google Play Store avec une signature appropriée
Clés et fichiers de clés Android
Projet Google Cloud Console avec la mise en œuvre de 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 nécessaire pour maintenir et déboguer le pipeline

Configuration de CI/CD professionnelle par Capgo

Sauter la complexité. Capgo configure votre pipeline CI/CD directement sur votre plateforme préférée :

Indépendance de la plateforme: Fonctionne avec GitHub Actions, GitLab CI ou autres
Intégration Saisissante: Pas de changement de plateforme nécessaire, fonctionne avec votre processus actuel
Configuration Adaptée: Paramétrage personnalisé correspondant aux besoins de votre projet
Conseil Expert: Nous avons déjà configuré CI/CD pour 50+ applications

Tarifs

Frais de mise en place unique : 2 600 $
Coûts de fonctionnement en cours : ~300 $ par an
Comparer à D'autres solution propriétaire : 6 000 $ par an
Économisez 26 100 $ sur 5 ans

Configurer le CI/CD maintenant

Guide de configuration manuelle

Si vous souhaitez toujours configurer tout vous-même, 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
Configurez votre flux de travail GitLab .yml

1. Copier 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 « chemins » personnalisés 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 GitLab CI/CD

GitLab propose une méthode pour stocker des variables CI/CD chiffrées, similaires aux secrets de votre dépôt GitHub.

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

ANDROID_KEYSTORE_FILE : le fichier base64 codé .jks ou .keystore utilisé pour signer vos builds Android. Il s'agira soit du fichier clé associé à votre clé d'upload (si vous utilisez Play App Signing), soit de votre clé de signature d'application.
KEYSTORE_KEY_PASSWORD : le mot de passe associé au fichier clé
KEYSTORE_KEY_ALIAS : l'alias de la clé de stockage
KEYSTORE_STORE_PASSWORD : le mot de passe de la clé privée
DEVELOPER_PACKAGE_NAME : votre ID d'application Android comme com.example.app
PLAY_CONFIG_JSON: La clé JSON du compte de service encodée en base64.

Création d'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 Google Play Android Developer API
Créez un compte de service :
- Allez dans « IAM & Admin » > « Comptes de service »
- Cliquez sur « Créer un compte de service »
- Donnez-lui un nom et une description
- Cliquez sur « Créer et continuer »
- Omettez l'attribution de rôle et cliquez sur « Terminé »
Générez une clé JSON :
- Trouvez votre compte de service dans la liste
- Cliquez sur le menu « … » > « Gérer les clés »
- Cliquez sur « Ajouter une clé » > « Créer une nouvelle clé »
- Choisissez le format JSON
- Cliquez sur « Créer »
Accordez au compte de service l'accès à votre application dans le Console de jeu :
- Allez à Console de jeu
- Naviguez vers « Utilisateurs et autorisations »
- Cliquez sur « Inviter de nouveaux utilisateurs »
- Entrez l'adresse e-mail du compte de service (se termine par @*.iam.gserviceaccount.com)
- Accordez la permission « Déploiement en production »
- Cliquez sur « Inviter un 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 en tant que PLAY_CONFIG_JSON variable dans GitLab

Configurer votre pipeline CI/CD 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 utiliser :


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éclenchez la pipeline

Lorsque vous publiez une nouvelle étiquette dans votre dépôt GitLab, GitLab CI/CD déclenchera automatiquement la pipeline définie, 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 libère votre temps pour vous concentrer sur les aspects clés du développement d'applications, ce qui vous aide finalement à livrer des applications Android de haute qualité de manière plus efficace.

Construction automatique de l'application Android Capacitor avec GitLab