Options de Configuration
Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complet pour ce plugin.
Référence complète pour chaque option de configuration de Cloud Build. Utilisez cette page pour trouver la CLI drapeau, variable d'environnement ou clé de crédential pour n'importe quelle configuration de build.
Prévalence de la configuration
Section intitulée “Prévalence de la configuration”Chaque option de build peut être définie de plusieurs manières. Lorsque la même option est définie dans plusieurs endroits, les sources de plus haute priorité gagnent :
flowchart LR
A["🔧 CLI Flag"] -->|overrides| B["🌍 Environment Variable"]
B -->|overrides| C["📁 Local Credentials"]
C -->|overrides| D["🏠 Global Credentials"]
style A fill:#6366f1,color:#fff,stroke:#4f46e5
style B fill:#8b5cf6,color:#fff,stroke:#7c3aed
style C fill:#a78bfa,color:#fff,stroke:#8b5cf6
style D fill:#c4b5fd,color:#1e1b4b,stroke:#a78bfa
Exemple : Si vos informations d'identification enregistrées ont SKIP_BUILD_NUMBER_BUMP=true mais vous passez --no-skip-build-number-bump sur le drapeau CLI, le drapeau CLI l'emporte et les numéros de build seront incrémentés automatiquement.
Options iOS
Section intitulée « Options iOS »Code Signature
Section intitulée « Code Signature »| CLI Drapeau | Variable d'environnement | Clé de la clé d'accès | Défaut | Description |
|---|---|---|---|---|
--build-certificate-base64 <cert> | BUILD_CERTIFICATE_BASE64 | BUILD_CERTIFICATE_BASE64 | — | Encodé en Base64 .p12 Certificat de distribution |
--ios-provisioning-profile <map> | CAPGO_IOS_PROVISIONING_MAP | CAPGO_IOS_PROVISIONING_MAP | — | Profil de provisionnement en tant que path ou bundleId=path correspondance. Répétable pour les applications multi-cibles (app + extensions) ; le nom du profil est extrait automatiquement. |
--p12-password <password> | P12_PASSWORD | P12_PASSWORD | — | Mot de passe pour le .p12 certificat (omettre si le certificat n'a pas de mot de passe) |
Authentification App Store Connect
Section intitulée “Authentification App Store Connect”| CLI Flag | Variable d'environnement | Clé de l'authentification | Par défaut | Description |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | Clé App Store Connect API ID |
--apple-issuer-id <id> | APPLE_ISSUER_ID | APPLE_ISSUER_ID | — | ID émetteur App Store Connect (UUID) |
--apple-key-content <content> | APPLE_KEY_CONTENT | APPLE_KEY_CONTENT | — | Clé App Store Connect API codée en Base64 (.p8 fichier) |
--app-store-connect-team-id <id> | APP_STORE_CONNECT_TEAM_ID | APP_STORE_CONNECT_TEAM_ID | — | ID d'équipe App Store Connect |
Authentification par mot de passe spécifique à l'application (non recommandée)
Section intitulée “Authentification par mot de passe spécifique à l'application (non recommandée)”| CLI Flag | Variable d'environnement | Clé de credenciaux | Défaut | Description |
|---|---|---|---|---|
--apple-id <email> | FASTLANE_USER | FASTLANE_USER | — | Adresse e-mail de l'ID Apple de la mise en relation qui possède l'application |
--apple-app-specific-password <password> | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | — | Mot de passe spécifique à l'application (xxxx-xxxx-xxxx-xxxx) généré à appleid.apple.com |
--apple-app-id <id> | APPLE_APP_ID | APPLE_APP_ID | — | ID numérique de l'application App Store Connect (par exemple 1234567890) |
Paramètres de build iOS
Section intitulée « Paramètres de build iOS »| Drapeau CLI | Variable d'environnement | Clé de la clé d'accès | Par défaut | Description |
|---|---|---|---|---|
--ios-scheme <scheme> | CAPGO_IOS_SCHEME | CAPGO_IOS_SCHEME | App | Nom de schéma Xcode pour la construction |
--ios-target <target> | CAPGO_IOS_TARGET | CAPGO_IOS_TARGET | App | Nom de cible Xcode pour la lecture des paramètres de construction |
--ios-distribution <mode> | CAPGO_IOS_DISTRIBUTION | CAPGO_IOS_DISTRIBUTION | app_store | Mode de distribution : app_store ou ad_hoc |
Options Android
Section intitulée “Options Android”Clé de signature de clé de coffre-fort
Section intitulée « Signature du coffre-fort »| CLI Flag | Variable d'environnement | Clé de la clé de confiance | Défaut | Description |
|---|---|---|---|---|
--android-keystore-file <keystore> | ANDROID_KEYSTORE_FILE | ANDROID_KEYSTORE_FILE | — | Fichier de coffre-fort codé en Base64 (.keystore ou .jks) |
--keystore-key-alias <alias> | KEYSTORE_KEY_ALIAS | KEYSTORE_KEY_ALIAS | key0 | Alias de la clé de coffre-fort |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Mot de passe de la clé de coffre-fort (retourne au mot de passe du magasin si non défini) |
--keystore-store-password <password> | KEYSTORE_STORE_PASSWORD | KEYSTORE_STORE_PASSWORD | — | Mot de passe du magasin de coffre-fort |
Configuration Google Play
Section intitulée « Configuration Google Play »| CLI Flag | Variable d'environnement | Clé de la clé de compte | Défaut | Description |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Clé JSON de service Google Play encodée en Base64 |
| (seulement en env) | PLAY_STORE_TRACK | — | internal | Piste de publication Google Play (internal, alpha, beta, production) |
| (seulement en env) | PLAY_STORE_RELEASE_STATUS | — | draft | État de publication sur la piste choisie (draft, completed, inProgress, halted) |
Paramètres de construction Android
Section intitulée « Paramètres de construction Android »| CLI Flag | Par défaut | Description |
|---|---|---|
--android-flavor <flavor> | — | Flavon de produit à construire (par exemple production). Requis si votre projet définit plusieurs saveurs. |
--in-app-update-priority <0–5> | — | Priorité de mise à jour en ligne de Google Play pour cette version (plus élevé = plus urgent). |
--no-playstore-upload | — | Construire et signer, mais ignorer l'envoi vers le magasin Play (exige --output-upload). |
Options de contrôle de construction
Section intitulée « Options de contrôle de construction »Ces options fonctionnent pour les builds iOS et Android.
Mode de construction
Section intitulée « Mode de construction »| CLI Flag | Par défaut | Description |
|---|---|---|
--platform <platform> | — | Obligatoire. ios ou android |
--build-mode <mode> | release | debug ou release |
--path <path> | . | Répertoire du projet |
--verbose | false | Activer la journalisation détaillée de la construction |
--ai-analytics | false | En cas d'échec de la construction, envoyer les journaux à Capgo AI pour le diagnostic — voir Diagnostic de construction par l'IA |
Contrôle du numéro de build
Section intitulée « Contrôle du numéro de build »| CLI Flag | Variable d'environnement | Clé de la clé d'accès | Défaut | Description |
|---|---|---|---|---|
--skip-build-number-bump | SKIP_BUILD_NUMBER_BUMP | SKIP_BUILD_NUMBER_BUMP | false | Ignorer l'incrémentation automatique du numéro de build / version code |
--no-skip-build-number-bump | — | — | — | Activer explicitement l'incrémentation automatique (annule les clés d'accès enregistrées) |
Par défaut, Capgo Cloud Build incrémente automatiquement les numéros de build :
- iOS : Récupère le dernier numéro de build de App Store Connect, incrémente de 1
- Android: Récupère max
versionCodeà partir de Google Play, incrémente de 1
Lorsque --skip-build-number-bump est défini, la construction utilise la version qui est déjà dans vos fichiers de projet (fichier de projet Xcode ou build.gradle).
Téléversement de sortie
Section intitulée “Téléversement de sortie”| CLI Flag | Variable d'environnement | Clé de la clé d'accès | Par défaut | Description |
|---|---|---|---|---|
--output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | BUILD_OUTPUT_UPLOAD_ENABLED | false | Télécharger les résultats de build (IPA/APK/AAB) vers le stockage Capgo. Lorsqu'il est défini via une variable d'environnement, utilisez BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Désactiver l'upload des résultats. Lorsqu'il est défini via une variable d'environnement, utilisez BUILD_OUTPUT_UPLOAD_ENABLED=false. |
--output-retention <duration> | BUILD_OUTPUT_RETENTION_SECONDS | BUILD_OUTPUT_RETENTION_SECONDS | 1h | Durée pendant laquelle les liens de téléchargement restent actifs |
--output-record <path> | — | — | — | Après une build réussie, écrire un enregistrement JSON (ID de job, statut, URL de téléchargement, QR code) à <path> — lire à nouveau avec build last-output. |
Format de conservation : Utiliser des durées lisibles par l'homme comme 1h, 6h, 2d, 7d. La valeur minimale est 1 heure, la valeur maximale est 7 jours. Lorsqu'il est défini via une variable d'environnement, utilisez des secondes (par exemple, 3600 pour 1 heure).
Authentification
Section intitulée « Authentification »| CLI Flag | Variable d'environnement | Défaut | Description |
|---|---|---|---|
-a, --apikey <key> | CAPGO_TOKEN | — | Capgo API clé d'authentification |
--supa-host <host> | — | — | Hôte Supabase personnalisé (hébergement autonome uniquement) |
--supa-anon <key> | — | — | Clé anonyme Supabase personnalisée (hébergement autonome uniquement) |
Référence rapide des variables d'environnement
Section intitulée “Référence rapide des variables d'environnement”Prêt à copier-coller pour votre pipeline CI/CD. Toutes les variables sont optionnelles — n'activez que ce dont vous avez besoin.
# Code signing (required for iOS builds)BUILD_CERTIFICATE_BASE64="<base64-encoded .p12>"CAPGO_IOS_PROVISIONING_MAP="<provisioning map generated by the CLI>"P12_PASSWORD="<certificate password>"
# App Store Connect (required for store submission)APPLE_KEY_ID="ABC1234567"APPLE_ISSUER_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"APPLE_KEY_CONTENT="<base64-encoded .p8 key>"APP_STORE_CONNECT_TEAM_ID="TEAM123456"
# Alternative to the App Store Connect API key above: Apple ID + app-specific# password (e.g. when migrating from Ionic Appflow). All three are required.# FASTLANE_USER="apple-id@example.com"# FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD="xxxx-xxxx-xxxx-xxxx"# APPLE_APP_ID="1234567890"
# Optional iOS settingsCAPGO_IOS_SCHEME="App"CAPGO_IOS_TARGET="App"# Keystore signing (required for Android builds)ANDROID_KEYSTORE_FILE="<base64-encoded .keystore>"KEYSTORE_KEY_ALIAS="my-key-alias"KEYSTORE_KEY_PASSWORD="<key password>"KEYSTORE_STORE_PASSWORD="<store password>"
# Google Play (required for store submission)PLAY_CONFIG_JSON="<base64-encoded service account JSON>"
# Optional Android settingsPLAY_STORE_TRACK="internal"PLAY_STORE_RELEASE_STATUS="draft"Contrôle de construction
Section intitulée « Contrôle de construction »# Build behaviorSKIP_BUILD_NUMBER_BUMP="true" # Skip auto-incrementBUILD_OUTPUT_UPLOAD_ENABLED="true" # Upload IPA/APK/AABBUILD_OUTPUT_RETENTION_SECONDS="3600" # 1 hour download link
# AuthenticationCAPGO_TOKEN="your-api-key"Stockage des informations d'identification
Section intitulée « Stockage des informations d'identification »Enregistrer les informations d'identification localement
Section intitulée « Enregistrer les informations d'identification localement »Au lieu de passer des drapeaux ou des variables d'environnement chaque fois, enregistrez les informations d'identification une fois :
# Save iOS credentialsbunx @capgo/cli@latest build credentials save \ --platform ios \ --certificate ./dist_cert.p12 \ --ios-provisioning-profile ./profile.mobileprovision \ --p12-password "cert-password" \ --apple-key ./AuthKey.p8 \ --apple-key-id ABC1234567 \ --apple-issuer-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ --apple-team-id TEAM123456
# Save Android credentialsbunx @capgo/cli@latest build credentials save \ --platform android \ --keystore ./release.keystore \ --keystore-alias my-key \ --keystore-key-password "key-pass" \ --keystore-store-password "store-pass" \ --play-config ./play-service-account.jsonEmplacements de stockage
Section intitulée « Emplacements de stockage »| Drapeau | Emplacement | Utilisation |
|---|---|---|
| (par défaut) | ~/.capgo-credentials/credentials.json | Global — partagé par tous les projets sur votre machine |
--local | .capgo-credentials.json dans le répertoire racine du projet | Par projet — remplace les paramètres globaux lorsqu'il existe les deux |
Les informations d'identification sont clés par ID d'application (par exemple, com.example.myapp), afin qu'un seul fichier d'informations d'identification peut stocker les paramètres pour plusieurs applications sans conflits. Les informations d'identification de chaque application sont encore plus décomposées par plateforme (ios / android).
Gérer les informations d'identification sauvegardées
Section intitulée « Gérer les informations d'identification sauvegardées »# List saved credentialsbunx @capgo/cli@latest build credentials list
# Update a specific option without re-entering everythingbunx @capgo/cli@latest build credentials update --skip-build-number-bump
# Clear saved credentialsbunx @capgo/cli@latest build credentials clear --platform iosExemples
Section intitulée « Exemples »GitHub Actions
Section intitulée « GitHub Actions »name: Build and Submiton: push: branches: [main]
jobs: build-ios: runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: oven-sh/setup-bun@v2 - run: bun install - run: bunx cap sync ios - run: bunx @capgo/cli@latest build request --platform ios env: CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }} BUILD_CERTIFICATE_BASE64: ${{ secrets.IOS_CERTIFICATE }} CAPGO_IOS_PROVISIONING_MAP: ${{ secrets.CAPGO_IOS_PROVISIONING_MAP }} P12_PASSWORD: ${{ secrets.P12_PASSWORD }} APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }} APPLE_ISSUER_ID: ${{ secrets.APPLE_ISSUER_ID }} APPLE_KEY_CONTENT: ${{ secrets.APPLE_KEY_CONTENT }} APP_STORE_CONNECT_TEAM_ID: ${{ secrets.APP_STORE_CONNECT_TEAM_ID }}
build-android: runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: oven-sh/setup-bun@v2 - run: bun install - run: bunx cap sync android - run: bunx @capgo/cli@latest build request --platform android env: CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }} ANDROID_KEYSTORE_FILE: ${{ secrets.ANDROID_KEYSTORE }} KEYSTORE_KEY_ALIAS: ${{ secrets.KEYSTORE_ALIAS }} KEYSTORE_KEY_PASSWORD: ${{ secrets.KEYSTORE_KEY_PASSWORD }} KEYSTORE_STORE_PASSWORD: ${{ secrets.KEYSTORE_STORE_PASSWORD }} PLAY_CONFIG_JSON: ${{ secrets.PLAY_CONFIG_JSON }}Utilisation directe des drapeaux CLI
Section intitulée « Utilisation directe des drapeaux CLI »# Build iOS with all options inlinebunx @capgo/cli@latest build request \ --platform ios \ --build-mode release \ --skip-build-number-bump \ --output-retention 6h \ --apikey YOUR_API_KEY
# Build Android, skip version bump, no output uploadbunx @capgo/cli@latest build request \ --platform android \ --skip-build-number-bump \ --no-output-upload \ --apikey YOUR_API_KEYConfiguration mixte
Section intitulée « Configuration mixte »Combinez les informations d'identification sauvegardées avec les CLI des paramètres de configuration :
# Save base credentials oncebunx @capgo/cli@latest build credentials save --platform ios \ --certificate ./cert.p12 \ --ios-provisioning-profile ./profile.mobileprovision \ --output-upload
# Override specific options per-buildbunx @capgo/cli@latest build request --platform ios \ --skip-build-number-bump \ --output-retention 2dLes informations d'identification sauvegardées fournissent les détails de signature tandis que les CLI des drapeaux définissent le comportement de construction pour cette exécution spécifique.