Automatic Capacitor IOS build with GitHub actions with certificate

Configurer la CI/CD pour les applications Capacitor peut être complexe et fastidieux. Voici ce dont vous avez besoin de savoir :

Recommandé pour les nouvelles constructions : Utilisez Capgo Build

On recommande maintenant d'utiliser Capgo Build avec le Capgo CLI pour les builds natifs Capacitor. Cette guide Fastlane est conservé pour les équipes qui maintiennent des pipelines d'actions GitHub existants, mais les nouveaux builds iOS devraient utiliser le Capgo CLI afin que vous ne deviez pas maintenir Fastlane, les exécutants Xcode, les certificats, et les scripts d'envoi.

Capgo Build pour la CI/CD par Capgo

Évitez la maintenance de Fastlane, de l'exécutant Xcode, du certificat, du profil de provisionnement, et du script d'envoi. Capgo Build exécute les builds natifs iOS signés à partir de votre pipeline CI/CD existante :

Fonctionne avec votre pipeline: Déclenchez Capgo Build à partir d'Actions GitHub, de GitLab CI, de Jenkins, ou de scripts locaux après votre build web et npx cap sync.
Authentification à partir de secrets CI: Conservez les clés App Store Connect, les certificats, les profils de provisionnement, les mots de passe et les identifiants d'équipe dans vos propres secrets CI.
Aucune maintenance du runner natif: Capgo Build fournit des environnements de build Apple maintenus, vous n'avez donc pas à gérer les runners macOS, les images Xcode ou les voies Fastlane.
Artéfacts et soumission: Téléchargez les artéfacts signés pour les tests de qualité ou soumettez des builds de mise en production à travers le Capgo CLI.

Tarification

Les plans Capgo 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 à l'aide de crédits

Configurez Capgo Build dans CI/CD

Guide de configuration manuelle

Voici ce que vous devez faire :

Déploiement continu pour iOS en utilisant Fastlane et GitHub Actions et certificat

Prérequis

Avant de continuer avec le tutoriel :

Assurez-vous d'avoir Fastlane installé sur votre machine de développement.
Vérifiez que vous êtes membre du programme de développeur iOS.

Informations importantes sur le prix

Prix de l'action GitHub

https://github.com/features/actions

Le service est ‘gratuit jusqu'à la limite, en fonction de la machine choisie.
Nous allons utiliser un ordinateur macOS machine, vous pouvez voir dans l'écran d'affichage son prix et ses limites (tarifs au moment de la création de la leçon, ils pourraient subir des changements à l'avenir)

Une fois averti des exigences et des prix, continuons.

Remarque : Dans l'article, je suppose que vous avez créé l'application dans App Store Connect. L'information importante sera copiée par Fastlane !

Qu'est-ce que vous allez apprendre dans la leçon

Étapes à suivre dans l'article

Utilisation d'App Store Connect API avec Fastlane
- Exigences :
  - Création d'une clé App Store Connect API
  - Utiliser une clé App Store Connect API
Copier les fichiers Fastlane
Configurer les actions GitHub

1. Utilisation de App Store Connect API avec Fastlane

À partir de février 2021, l'authentification à deux facteurs ou la vérification à deux étapes est obligatoire pour tous les utilisateurs pour se connecter à App Store Connect. Cette couche supplémentaire de sécurité pour votre ID Apple vous aide à vous assurer que vous êtes la seule personne qui peut accéder à votre compte.
De Support Apple

Exigences

Pour que Fastlane puisse utiliser App Store Connect API pour télécharger votre application, vous devez fournir les éléments suivants trois choses :

Identifiant émetteur
ID de clé
Fichier de clé ou contenu de clé

Obtenir une clé API App Store Connect

Pour générer des clés, vous devez avoir les droits d'administrateur dans App Store Connect. Si vous n'avez pas ces droits, vous pouvez diriger la personne concernée à cet article.

Se connecter à App Store Connect.
Sélectionner Utilisateurs et accès.

Accès à l'utilisateur App Store Connect

3 — Sélectionner l'onglet Intégration.

Intégration API App Store Connect

Cliquez sur Générer clé API ou le bouton Ajouter (+).

App Store Connect API clés créer

Entrez un nom pour la clé. Le nom est uniquement pour votre référence et n'est pas partie de la clé elle-même.

App Store Connect API clés créer nom

6 — Dans l'accès, sélectionnez le rôle pour la clé. Les rôles qui s'appliquent aux clés sont les mêmes rôles qui s'appliquent aux utilisateurs de votre équipe. Voir permissions de rôle. Nous recommandons de sélectionner Gestionnaire d'applications.

Cliquez sur Générer.

L'accès d'une clé API ne peut pas être limité à des applications spécifiques.

Le nom de la nouvelle clé, l'ID de la clé, un lien de téléchargement et d'autres informations apparaissent sur la page.

App Store Connect télécharger les clés

Vous pouvez récupérer toutes les trois informations nécessaires ici.
<1> ID de l'incident. (APPLE_ISSUER_ID Clé secrète
<2> ID de la clé. (APPLE_KEY_ID Clé secrète
<3> Cliquez sur « Télécharger la clé API » pour télécharger votre clé privée API . Le lien de téléchargement n'apparaît que si la clé privée n'a pas encore été téléchargée. Apple ne garde pas de copie de la clé privée. Vous pouvez donc la télécharger qu'une seule fois.

🔴 Stockez votre clé privée dans un endroit sûr. Vous ne devriez jamais partager vos clés, stocker les clés dans un code dépôt ou inclure les clés dans du code côté client.

Utilisation d'une clé API App Store Connect

Le fichier de clé API (fichier p8 que vous téléchargez), l'ID de la clé et l'ID de l'émetteur sont nécessaires pour créer le jeton JWT d'autorisation. Il existe plusieurs façons de passer ces informations dans Fastlane. J'ai choisi d'utiliser l'action de Fastlane nouvelle app_store_connect_api_keyVous pouvez apprendre d'autres façons dans Documentation de FastlaneJe montre cette méthode parce que je pense qu'elle est la plus facile à utiliser avec la plupart des CI en place, où vous pouvez définir des variables d'environnement.

Veuillez convertir le fichier p8 que vous téléchargez en Base64 et le stocker sous forme de secretAPPLE_KEY_CONTENT).

base64 -i APPLE_KEY_CONTENT.p8 | pbcopy

Maintenant, nous pouvons gérer l'App Store Connect avec Fastlane à l'aide de la clé API, c'est génial !

2. Certificats

Ouvrez XCode et allez à Paramètres > Comptes > Identifiant Apple > Équipes et sélectionnez votre équipe.

Les identités de signature Code

Cliquez sur Gérer les certificats.

Si vous n'avez pas déjà créé de certificat, vous pouvez créer un nouveau certificat.

Cliquez sur + et sélectionnez Distribution Apple

Distribution Apple

Ensuite, vous devez aller dans la clé de chiffrement pour télécharger le certificat sous forme de .p12 fichier.

Pour ce faire, vous devez aller dans la clé de chiffrement, passer à la clé de chiffrement login et puis la vue Mes Certificats.

Mes Certificats

Ensuite, vous pouvez sélectionner le certificat que vous souhaitez télécharger. (Recherchez par la date du certificat)

Ensuite, cliquez avec le bouton droit sur la clé privée sur le certificat et sélectionnez Exporter.

Choisissez le format de fichier Informations personnelles d'échange (.p12).

Cela téléchargera le certificat sous la forme d'un .p12 fichier.

Veuillez ouvrir le fichier dans un terminal et utilisez la commande suivante pour le convertir en Base64 :

base64 -i BUILD_CERTIFICATE.p12 | pbcopy

Cela deviendra votre BUILD_CERTIFICATE_BASE64 secret. Il est également recommandé de fournir le mot de passe du certificat lorsqu'il vous est demandé. Ce mot de passe sera votre P12_PASSWORD secret.

3. Profils de provisionnement

Ouvrez Apple Developer et sélectionnez l'équipe appropriée.

Créez ensuite un nouveau profil en cliquant sur +

Créer un nouveau profil

Et sélectionnez App Store Connect.

Sélectionnez App Store Connect

Vous devez ensuite sélectionner l'application appropriée, soyez prudent, vous ne pouvez pas utiliser des wildcards sinon la signature échouera.

Sélectionnez l'application appropriée

Sélectionnez le certificat approprié que vous avez créé avant (cherchez la date d'expiration, elle doit être la même journée et mois que aujourd'hui) et cliquez sur Continuer.

Sélectionnez le certificat approprié

Enfin, entrez le nom du profil et cliquez sur Générer.

Le nom sera utilisé pour identifier le profil dans Fastlane, sous la valeur de APPLE_PROFILE_NAME.

Générer le profil

Vous pouvez télécharger le profil sous forme de .mobileprovision fichier.

Télécharger le profil

Veuillez convertir le profil en Base64 et le stocker comme un secret (BUILD_PROVISION_PROFILE_BASE64).

base64 -i BUILD_PROVISION_PROFILE.mobileprovision | pbcopy

4. 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 « voies » personnalisées qui rassemblent une série d'« actions » qui exécutent des tâches que vous effectueriez normalement à l'aide d'Android Studio. Vous pouvez faire beaucoup de choses avec Fastlane, mais pour les besoins de ce tutoriel, nous utiliserons uniquement une poignée d'actions de base.

Créez le dossier Fastlane à la racine de votre projet Capacitor/Ionic et ajoutez-y le fichier Fastfile :

Dossier : <project-root>/fastlane/
Dossier : <project-root>/fastlane/Fastfile

C'est le même niveau que package.json, capacitor.config.*, et le ios/ dossier. N'oubliez pas de ne pas le créer à l'intérieur de ios/App/.

platform :ios do
  desc 'Export ipa and submit to TestFlight'
  lane :beta do
    keychain_info = { keychain_name: "ios-build-#{Time.now.to_i}.keychain", keychain_password: SecureRandom.uuid }
    
    begin
      setup_signing(keychain_info)
      bump_build_number
      build_app_with_signing(keychain_info)
      submit_to_testflight
    ensure
      cleanup_keychain(keychain_info)
    end
  end

  private_lane :setup_signing do |options|
    create_keychain(
      name: options[:keychain_name],
      password: options[:keychain_password],
      unlock: true,
      timeout: 0,
      lock_when_sleeps: false, 
      add_to_search_list: true
    )
    import_cert(options)
    install_profile
    update_project_settings
  end

  lane :bump_build_number do
		file = File.read('../package.json')
		data_hash = JSON.parse(file)
		api_key = app_store_connect_api_key(
      key_id: ENV['APPLE_KEY_ID'],
      issuer_id: ENV['APPLE_ISSUER_ID'],
      key_content: ENV['APPLE_KEY_CONTENT'],
      is_key_content_base64: true,
      duration: 1200,
      in_house: false
    )
		build_num = app_store_build_number(
      api_key: api_key,
			app_identifier: ENV['BUNDLE_IDENTIFIER'],
			live: false
    )
		build_num = build_num + 1
		UI.message("Bumped build number to #{build_num}")
		increment_build_number(
			build_number: build_num,
			xcodeproj: "./ios/App/App.xcodeproj",
			skip_info_plist: true
		)
	end

  private_lane :import_cert do |options|
    cert_path = "#{Dir.tmpdir}/build_certificate.p12"
    File.write(cert_path, Base64.decode64(ENV['BUILD_CERTIFICATE_BASE64']))
    import_certificate(
      certificate_path: cert_path,
      certificate_password: ENV['P12_PASSWORD'] || "",
      keychain_name: options[:keychain_name],
      keychain_password: options[:keychain_password],
      log_output: true
    )
    File.delete(cert_path)
  end  
  
  private_lane :cleanup_keychain do |options|
    delete_keychain(
      name: options[:keychain_name]
    )
  end  

  private_lane :install_profile do
    profile_path = "#{Dir.tmpdir}/build_pp.mobileprovision"
    File.write(profile_path, Base64.decode64(ENV['BUILD_PROVISION_PROFILE_BASE64']))
    UI.user_error!("Failed to create provisioning profile at #{profile_path}") unless File.exist?(profile_path)
    ENV['PROVISIONING_PROFILE_PATH'] = profile_path
    install_provisioning_profile(path: profile_path)
    File.delete(profile_path)
  end

  private_lane :update_project_settings do
    update_code_signing_settings(
      use_automatic_signing: false,
      path: "./ios/App/App.xcodeproj",
      code_sign_identity: "iPhone Distribution",
      profile_name: ENV['APPLE_PROFILE_NAME'],
      bundle_identifier: ENV['BUNDLE_IDENTIFIER'],
      team_id: ENV['APP_STORE_CONNECT_TEAM_ID']
    )
    update_project_team(
      path: "./ios/App/App.xcodeproj",
      teamid: ENV['APP_STORE_CONNECT_TEAM_ID']
    )
  end

  private_lane :build_app_with_signing do |options|
    unlock_keychain(
      path: options[:keychain_name],
      password: options[:keychain_password],
      set_default: false
    )
    build_app(
      workspace: "./ios/App/App.xcworkspace",
      scheme: "App",
      configuration: "Release",
      export_method: "app-store",
      output_name: "App.ipa",
      export_options: {
        provisioningProfiles: {
          ENV['BUNDLE_IDENTIFIER'] => ENV['APPLE_PROFILE_NAME']
        }
      },
      xcargs: "-verbose",
      buildlog_path: "./build_logs",
      export_xcargs: "-allowProvisioningUpdates",
    )
  end   

  private_lane :submit_to_testflight do
    api_key = app_store_connect_api_key(
      key_id: ENV['APPLE_KEY_ID'],
      issuer_id: ENV['APPLE_ISSUER_ID'],
      key_content: ENV['APPLE_KEY_CONTENT'],
      is_key_content_base64: true,
      duration: 1200,
      in_house: false
    )
    pilot(
      api_key: api_key,
      skip_waiting_for_build_processing: true,
      skip_submission: true,
      distribute_external: false,
      notify_external_testers: false,
      ipa: "./App.ipa"
    )
  end
end

5. Configuration des secrets

GitHub Actions utilise les secrets de votre référentiel que vous configurez dans l'étape suivante. Vous n'avez besoin que d'un fichier local .env si vous souhaitez exécuter ou tester Fastlane depuis votre propre machine.

Pour les tests locaux, créez <project-root>/fastlane/.env à côté du Fastfile. N'oubliez pas de ne pas le commiter. Ajoutez fastlane/.env à votre .gitignore premier (ou vérifiez qu'il est déjà ignoré). Voici un exemple :

APP_STORE_CONNECT_TEAM_ID=UVTJ336J2D
BUNDLE_IDENTIFIER=ee.forgr.testfastlane
# See previous section for these secrets
BUILD_CERTIFICATE_BASE64=
BUILD_PROVISION_PROFILE_BASE64=
APPLE_KEY_ID=
APPLE_ISSUER_ID=
APPLE_KEY_CONTENT=
P12_PASSWORD=
APPLE_PROFILE_NAME=

Obtenir l'ID DÉVELOPPEUR DE L'APP STORE CONNECT

Allez à Centre de développement et faites défiler vers le bas jusqu'à la Membership details section. Team ID est la valeur que vous devez définir dans le APP_STORE_CONNECT_TEAM_ID secret.

Obtenir l'IDENTIFIANT DE L'ENVELOPPE BUNDLE

Ouvrez Xcode
Faites double-cliquer sur le App dans le navigateur de projet
Cliquez ensuite sur l'onglet Signing and Capabilities
Copiez la valeur de Bundle identifierC'est la valeur que vous devez définir dans le BUNDLE_IDENTIFIER secret.

6. Traitement de la mise à jour

Dans les GitHub Actions, vous êtes facturés en fonction des minutes que vous avez utilisées pour exécuter votre flux de travail CI/CD. D'après mon expérience, il faut environ 10-15 minutes avant que la mise à jour ne soit traitée dans App Store Connect.

Pour les projets privés, le coût estimé par build peut aller jusqu'à $0,08/min x 15 min = $1,2, ou plus, en fonction de la configuration et des dépendances de votre projet.

Si vous vous inquiétez des coûts pour les projets privés, vous pouvez configurer skip_waiting_for_build_processing pour trueCela économisera des minutes de construction en ne faisant pas attendre App Store Connect pour terminer le traitement de la construction.

Cependant, il y a un compromis - vous devrez mettre à jour manuellement les informations de conformité de votre application dans App Store Connect avant de pouvoir distribuer la construction aux utilisateurs.

This optimization is mainly useful for private projects where build minutes cost money. For public/free projects, the build minutes are free so there’s no need to enable this setting. See GitHub’s Pour les projets publics/gratuits, les minutes de construction sont gratuites, il n'y a donc pas besoin d'activer cette configuration. Voir la page de tarification de __CAPGO_KEEP_0__ pour plus de détails.

7. Configuration des actions de GitHub

Configurez les secrets de GitHub

Veuillez copier les secrets du .env fichier et les coller dans les secrets de l'organisation GitHub.

Allez à Paramètres > Secrets et variables > Actions > Nouveau secret de dépôt

2. BUILD_CERTIFICATE_BASE64 Certificat encodé en Base64.

3. BUILD_PROVISION_PROFILE_BASE64 Profil de provisionnement encodé en Base64.

4. BUNDLE_IDENTIFIER Identifiant de l'application.

5. APPLE_KEY_ID Clé App Store Connect API 🔺ID de la clé.

6. APPLE_ISSUER_ID Clé App Store Connect API 🔺ID de l'émetteur.

7. APPLE_KEY_CONTENT Clé App Store Connect API 🔺Contenu de la clé. Fichier .p8, vérifiez-le

8. Configurez le fichier de flux de travail GitHub

Créez un répertoire de flux de travail GitHub.

cd .github/workflows

À l'intérieur du workflow répertoire, créez un fichier nommé build-upload-ios.ymlet ajoutez le contenu suivant.

name: Build source code on ios

on:
  push:
    tags:
      - '*'

jobs:
  build_ios:
    runs-on: macOS-latest
    steps:
      - uses: actions/checkout@v6
      - name: Set Node.js
        uses: actions/setup-node@v6
        with:
          node-version: 24
          cache: npm
      - name: Install dependencies
        id: install_code
        run: npm ci
      - name: Build
        id: build_code
        run: npm run build
      - uses: actions/cache@v5
        with:
          path: ios/App/Pods
          key: ${{ runner.os }}-pods-${{ hashFiles('**/Podfile.lock') }}
          restore-keys: |
            ${{ runner.os }}-pods-
      - name: Sync
        id: sync_code
        run: npx cap sync
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.0'
          bundler-cache: true
      - uses: maierj/fastlane-action@v3.1.0
        env:
          APP_STORE_CONNECT_TEAM_ID: ${{ secrets.APP_STORE_CONNECT_TEAM_ID }}
          BUNDLE_IDENTIFIER: ${{ secrets.BUNDLE_IDENTIFIER }}
          BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }}
          BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.BUILD_PROVISION_PROFILE_BASE64 }}
          APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }}
          APPLE_ISSUER_ID: ${{ secrets.APPLE_ISSUER_ID }}
          APPLE_KEY_CONTENT: ${{ secrets.APPLE_KEY_CONTENT }}
          P12_PASSWORD: ${{ secrets.P12_PASSWORD }}
          APPLE_PROFILE_NAME: ${{ secrets.APPLE_PROFILE_NAME }}
        with:
          lane: ios beta
      - name: Upload release bundle
        uses: actions/upload-artifact@v6
        with:
          name: ios-release
          path: ./App.ipa
          retention-days: 10

Ce flux de travail doit être déclenché après chaque GitHub tag, si vous avez besoin d'automatiser les tags, veuillez vous référer à Automatic build and release avec les actions GitHub en premier.

Ensuite, ce flux de travail tirera vos dépendances NodeJS, les installera et construira votre application JavaScript.

Chaque fois que vous envoyez un nouveau commit, une mise à jour sera construite dans TestFlight.

Votre application n'a pas besoin d'utiliser Ionic, seule la base Capacitor est obligatoire, elle peut avoir des anciens modules Cordova, mais le plugin JS Capacitor est préférable.

8. Déclencher le flux de travail

Créer un Commit

Faites un commitpuis vous devriez voir le flux de travail actif dans le dépôt.

Déclencher le flux de travail

Pousser les nouveaux commits vers la branche main ou development pour déclencher le flux de travail.

Démarré avec commit

Après quelques minutes, la mise à jour devrait être disponible dans votre tableau de bord App Store Connect.

Tableau de bord Testflight

9. Puis-je déployer depuis ma machine locale ?

Oui, vous pouvez, et cela est facile.

Vous pouvez utiliser Xcode pour construire et signer votre application, comme toujours.

Guides de configuration CI/CD

Déploiement automatique de l'Capacitor Android avec des GitHub Actions - Configuration complète de CI/CD Android
Déploiement automatique et publication avec des GitHub Actions - Tutoriel complet de la chaîne de pipeline CI/CD
Gestion des builds Dev et Prod avec des GitHub Actions - Gestion de l'environnement
Construction automatique de l'Capacitor iOS avec Match - Alternative utilisant Fastlane Match

Plateformes alternatives CI/CD

Construction avec GitLab CI - Alternative de GitLab
Construction avec CodeMagic - Guide de configuration de CodeMagic

Mises à jour en temps réel et déploiement

Capgo Documentation des mises à jour en temps réel - Ajouter des mises à jour OTA à votre application
Intégration CI/CD avec Capgo - Intégrez les mises à jour en temps réel dans votre pipeline

Merci

Cet article est basé sur les articles suivants :

Keep going from Automatic Capacitor IOS build with GitHub actions with certificate

Si vous utilisez Automatic Capacitor IOS build with GitHub actions with certificate pour planifier l'automatisation CI/CD, connectez-le avec Capgo CI/CD pour le flux de travail du produit dans Capgo CI/CD, Capgo Builds natifs pour le flux de travail du produit dans Capgo Builds 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 IOS avec des GitHub actions avec certificat