Options de configuration
Copiez un prompt de configuration avec les étapes d'installation et le guide Markdown complet pour ce plug-in.
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 toute configuration de build.
Prééminence de la configuration
Section intitulée « Prééminence 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 de connexion enregistrées ont SKIP_BUILD_NUMBER_BUMP=true mais vous passez --no-skip-build-number-bump sur le CLI, la CLI flag gagne et les numéros de build seront incrémentés automatiquement.
Sous-section intitulée « Options iOS »
__CAPGO_KEEP_0__ SignatureSous-section intitulée « Code Signature »
Code Flag| CLI Flag | Clé de l'information de connexion | Sous-section intitulée « __CAPGO_KEEP_0__ Flag » | Default | 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 ou |
--p12-password <password> | P12_PASSWORD | P12_PASSWORD | — | Configuration de la carte de provisionnement. Répétable pour les applications multi-cibles (application + extensions) ; le nom de la carte est automatiquement extrait. .p12 Mot de passe pour le |
certificat (omettre si le certificat n'a pas de mot de passe)
Authentification App Store Connect| CLI Flag | Variable d'environnement | Clé de mot de passe | Par défaut | Description |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | Clé ID d'App Store Connect API |
--apple-issuer-id <id> | APPLE_ISSUER_ID | APPLE_ISSUER_ID | — | ID émetteur d'App Store Connect (UUID) |
--apple-key-content <content> | APPLE_KEY_CONTENT | APPLE_KEY_CONTENT | — | Clé d'App Store Connect API encodée en Base64 (.p8 fichier) |
--app-store-connect-team-id <id> | APP_STORE_CONNECT_TEAM_ID | APP_STORE_CONNECT_TEAM_ID | — | ID d'équipe d'App Store Connect |
Authentification par mot de passe spécifique à l'application (non recommandée)
Sous-section intitulée « Authentification par mot de passe spécifique à l'application (non recommandée) »| CLI Flag | Variable d'environnement | Clé de credenciaux | Valeur par défaut | Description |
|---|---|---|---|---|
--apple-id <email> | FASTLANE_USER | FASTLANE_USER | — | Adresse e-mail de l'ID Apple de la compte 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 | — | Identifiant d'application App Store Connect numérique (par exemple 1234567890) |
Paramètres de construction iOS
Section intitulée « Paramètres de construction iOS »| CLI Flag | Variable d'environnement | Clé de l'authentification | Par défaut | Description |
|---|---|---|---|---|
--ios-scheme <scheme> | CAPGO_IOS_SCHEME | CAPGO_IOS_SCHEME | App | Schéma Xcode pour la construction |
--ios-target <target> | CAPGO_IOS_TARGET | CAPGO_IOS_TARGET | App | 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 |
Quels sont les avantages de nos solutions alternatives ? | Quels sont les avantages de nos solutions alternatives ? | Quels sont les avantages de nos solutions alternatives ? | Quels sont les avantages de nos services de consulting ? | Solutions alternatives
Options AndroidOptions Android
Signature de clé de magasin Keystore| CLI Flag | Drapeau __CAPGO_KEEP_0__ | Variable d'environnement : __CAPGO_KEEP_0__ : __CAPGO_KEEP_0__ : Clé de credenciaux | Par défaut | Description |
|---|---|---|---|---|
--android-keystore-file <keystore> | ANDROID_KEYSTORE_FILE | ANDROID_KEYSTORE_FILE | — | Fichier de clé sécurisé encodé en Base64 (".keystore ou .jks) |
--keystore-key-alias <alias> | KEYSTORE_KEY_ALIAS | KEYSTORE_KEY_ALIAS | key0 | Alias de clé du coffre de clés |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Mot de passe de la clé de clé de magasin (redevient le 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 clés |
Configuration Google Play
Configuration Google Play| Drapeau CLI | Variable d'environnement | Clé de connexion | Par défaut | Description |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Clé JSON de compte Google Play encodée en Base64 |
--android-track <track> | PLAY_STORE_TRACK | PLAY_STORE_TRACK | internal ou production avec --submit-to-store-review) | Suivi de lancement Google Play (internal, alpha, beta, production) Envoyé à partir de l'environnement CI / CLI vers le lancer de construction. |
--android-release-status <status> | PLAY_STORE_RELEASE_STATUS | PLAY_STORE_RELEASE_STATUS | draft ou completed avec --submit-to-store-review) | Statut de lancement sur le chemin choisi (draft, completed, inProgress, halted) Les valeurs explicites dépassent la valeur par défaut. --submit-to-store-review default. |
Paramètres de construction Android
Section intitulée « Paramètres de construction Android »| CLI Flag | Défaut | Description |
|---|---|---|
--android-flavor <flavor> | — | Flavor de produit à construire (par exemple production). Requis Si votre projet définit plusieurs saveurs. |
--android-track <track> | internal | Piste Google Play pour cet envoi. Avec --submit-to-store-review et sans piste définie, Capgo se définit par production. |
--android-release-status <status> | draft | statut de publication Google Play. Avec --submit-to-store-review et sans statut défini, Capgo se définit par completed. |
--in-app-update-priority <0–5> | — | Priorité de mise à jour en-ligne Google Play pour cette version (plus élevé = plus urgent). |
--no-playstore-upload | — | Construire et signer, mais ignorer l'upload de la boutique 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> | . | Dossier du projet |
--verbose | false | Activer la journalisation détaillée de la construction |
--ai-analytics | false | Lors d'une erreur de construction, envoyer les journaux à l'IA Capgo pour un diagnostic — voir Diagnostic de construction par l'IA |
Contrôle du numéro de construction
Section intitulée « Contrôle du numéro de construction »| CLI Flag | Variable d'environnement | Clef de crédential | Par défaut | Description |
|---|---|---|---|---|
--skip-build-number-bump | SKIP_BUILD_NUMBER_BUMP | SKIP_BUILD_NUMBER_BUMP | false | Passer automatiquement le numéro de build / version code |
--no-skip-build-number-bump | — | — | — | Activer explicitement l'auto-incrémentation (remplace les informations de connexion sauvegardé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 sur App Store Connect, incrémente de 1
- Android : Récupère le max
versionCodede Google Play, incrémente de 1
Lorsque --skip-build-number-bump est défini, la build utilise la version qui est déjà dans vos fichiers de projet (projet Xcode ou) build.gradle).
Section intitulée « Chargement de sortie »
Section intitulée “Chargement de sortie”| CLI Flag | Variable d'environnement | Clé de mot de passe | Valeur 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 Capgo stockage. Lorsqu'il est défini via une variable d'environnement, utilisez BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Empêcher la téléchargement des résultats de build. 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 de 1 heure, la valeur maximale est de 7 jours. Lorsque défini via une variable d'environnement, utilisez les secondes (par exemple, 1 heure). 3600 for 1 hour).
Cache de construction
Section intitulée “Cache de construction”Capgo enregistre les artefacts natifs compilés (CocoaPods, Gradle et les sorties de construction connexes) par application afin que les reconstructions de builds commencent plus rapidement. Le cache de construction est activé par défaut pour chaque application.
| CLI Flag | API Champ | Valeur par défaut | Description |
|---|---|---|---|
--no-cache | cache_enabled: false | cache sur | Désactiver le cache pour cette construction : ignorer le rétablissement et ne pas enregistrer une nouvelle entrée |
--cache-key <value> | cache_key | (omettre) | Partitionner le cache (par exemple prod, staging) Omettre pour une cache partagée générale par application |
CLI équivalents : build request accepte --no-cache et --cache-key.
CLI exemples :
# Default: restore/save the shared per-app cachebunx @capgo/cli@latest build request com.example.app --platform android
# Separate caches per environmentbunx @capgo/cli@latest build request com.example.app --platform android \ --cache-key=prod
bunx @capgo/cli@latest build request com.example.app --platform android \ --cache-key=staging \ --android-flavor staging
# One-off clean build (no restore, no save)bunx @capgo/cli@latest build request com.example.app --platform ios --no-cacheAPI / payload de webhook (lorsque votre intégration appelle Capgo Construire directement :)
{ "platform": "android", "cache_key": "prod"}Omettre cache_key pour le cache général partagé. Définir cache_key pour partitionner par environnement. Définir "cache_enabled": false pour désactiver la mise en cache pour une seule requête (même chose que --no-cache).
Si une construction semble réussie mais l'artifact est incorrect — ou un AAB Android manque après avoir changé RC vs production — essayez une clé de cache dédiée ou une construction unique. --no-cache Voir Résolution de problèmes : restauration de cache incorrecte.
Authentification
Sous-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> | — | — | Serveur 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'ajoutez 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 la construction
Section intitulée « Contrôle de la 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 »Plutôt que 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 | Lieu | Utilisation |
|---|---|---|
| context : Page/zone : Page de marketing des solutions Capgo. Rôle : Étiquette de navigation ou élément de l'interface utilisateur court. Vu dans : page solutions/cordova-to-capacitor-ai.astro. Clé de message `solutions_cordova_to_capacitor_ai_table_use_case` (Solutions Cordova To Capacitor Ai Table Use Case). | ~/.capgo-credentials/credentials.json | (par défaut) |
--local | .capgo-credentials.json Global — partagé par tous les projets sur votre machine | Dans le répertoire root du projet |
Par projet — remplace le global lorsqu'il existe à la fois Les informations d'identification sont associées à ID d'application : : (par exemple com.example.myapp), afin qu'un seul fichier de credenciaux puisse stocker les paramètres pour plusieurs applications sans conflits. Les credenciaux de chaque application sont encore plus décomposés par plateforme (ios / android).
Sous-section intitulée « Gérer les Credenciaux Sauvés »
Fenêtre de terminal# 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 iosSous-section intitulée « Exemples »
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 des drapeaux CLI directement
Section intitulée “Utilisation des drapeaux CLI directement”# 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 surcharges :
# 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 de connexion sauvegardées fournissent les détails de signature tandis que les drapeaux CLI définissent le comportement de construction pour cette exécution spécifique.