Options de configuration
Copiez une commande de configuration avec les étapes d'installation et la guide markdown complète 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 credential pour toute configuration de build.
Prévalence de la configuration
Section intitulée « Prévalence de la configuration »Chaque option de construction peut être définie de plusieurs manières. Lorsque la même option est définie dans plusieurs endroits, les sources de priorité élevée 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 CLI, le drapeau CLI gagne et les numéros de construction seront incrémentés automatiquement.
Options iOS
Options iOSCode Signature
Section intitulée « Code Signature »| CLI Drapeau | Variable d'environnement | Clé de la clé d'accès | Par défaut | Description |
|---|---|---|---|---|
--build-certificate-base64 <cert> | BUILD_CERTIFICATE_BASE64 | BUILD_CERTIFICATE_BASE64 | — | Encodé en Base64 .p12 Certificat de distribution |
--build-provision-profile-base64 <profile> | BUILD_PROVISION_PROFILE_BASE64 | BUILD_PROVISION_PROFILE_BASE64 | — | Encodé en Base64 .mobileprovision Profil de provisionnement |
--build-provision-profile-base64-prod <profile> | BUILD_PROVISION_PROFILE_BASE64_PROD | BUILD_PROVISION_PROFILE_BASE64_PROD | — | Profil de provisionnement de production (facultatif, pour la distribution sur l'App Store) |
--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 la clé d'accès | Défaut | Description |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | Clé d'ID App Store Connect API |
--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 | — | Base64-encoded App Store Connect API key (.p8 Nom du profil de provisionnement tel qu'affiché sur le portail Apple Developer |
--apple-profile-name <name> | APPLE_PROFILE_NAME | APPLE_PROFILE_NAME | — | ID d'équipe d'App Store Connect |
--app-store-connect-team-id <id> | APP_STORE_CONNECT_TEAM_ID | APP_STORE_CONNECT_TEAM_ID | — | Remarque |
Clés d'application App Store Connect codées en Base64 (
Section intitulée « Paramètres de construction iOS »| CLI Flag | Variable d'environnement | Clé de la clé d'accès | 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 | Cible Xcode pour la lecture des paramètres de construction |
Options Android
Section intitulée « Options Android »Signature de clé de coffre-fort
Section intitulée « Signature de clé de coffre-fort »| Drapeau CLI | Variable d'environnement | Clé de la clé d'accès | Par défaut | Description |
|---|---|---|---|---|
--android-keystore-file <keystore> | ANDROID_KEYSTORE_FILE | ANDROID_KEYSTORE_FILE | — | Fichier de clé de coffre chiffré au format Base64 (.keystore ou .jks) |
--keystore-key-alias <alias> | KEYSTORE_KEY_ALIAS | KEYSTORE_KEY_ALIAS | key0 | Alias de clé de coffre |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Mot de passe de clé de coffre (retourne au mot de passe de magasin si non défini) |
--keystore-store-password <password> | KEYSTORE_STORE_PASSWORD | KEYSTORE_STORE_PASSWORD | — | Mot de passe de magasin de clés |
Configuration Google Play
Section intitulée “Configuration Google Play”| CLI Drapeau | Variable d'environnement | Clé de la clé de compte | Valeur par défaut | Description |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Clé JSON de compte Google Play encodée en Base64 |
Paramètres de construction Android
Section intitulée « Paramètres de construction Android »| Variable d'environnement | Valeur par défaut | Description |
|---|---|---|
PLAY_STORE_TRACK | internal | Piste de publication Google Play (internal, alpha, beta, production) |
PLAY_STORE_RELEASE_STATUS | draft | Statut de publication sur Google Play (draft, completed) |
Options de contrôle de la construction
Section intitulée « Options de contrôle de la 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 |
--build-config <json> | — | Configuration JSON de build supplémentaire |
--path <path> | . | Répertoire du projet |
--verbose | false | Activer la journalisation détaillée de build |
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 | — | — | — | Ré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 depuis 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 “Téléchargement de sortie”
__CAPGO_KEEP_0__ Flag| CLI Flag | Env Variable | Clé de l'authentification | 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. BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Lorsque défini via la variable d'environnement, utilisez BUILD_OUTPUT_UPLOAD_ENABLED=false. |
--output-retention <duration> | BUILD_OUTPUT_RETENTION_SECONDS | BUILD_OUTPUT_RETENTION_SECONDS | 1h | Désactiver la téléchargement des résultats de build. |
Lorsque défini via la variable d'environnement, utilisez Durée pendant laquelle les liens de téléchargement restent actifs 1h, 6h, 2d, 7dFormat de conservation : 3600 Utiliser des durées lisibles par l'homme comme
Minimum est 1 heure, maximum est 7 jours. Lorsque défini via la variable d'environnement, utilisez des secondes (par exemple,
Authentification| CLI Drapeau | 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'ajoutez que ce dont vous avez besoin.
# Code signing (required for iOS builds)BUILD_CERTIFICATE_BASE64="<base64-encoded .p12>"BUILD_PROVISION_PROFILE_BASE64="<base64-encoded .mobileprovision>"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>"APPLE_PROFILE_NAME="My App Distribution Profile"APP_STORE_CONNECT_TEAM_ID="TEAM123456"
# 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 build credentials save \ --platform ios \ --certificate ./dist_cert.p12 \ --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-profile-name "My App Profile" \ --apple-team-id TEAM123456
# Save Android credentialsbunx @capgo/cli 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é entre tous les projets sur votre machine |
--local | .capgo-credentials.json dans le dossier racine du projet | Par projet — remplace les paramètres globaux lorsqu'il y en a plusieurs |
Les informations d'identification sont clés par ID de l'application (par exemple, com.example.myapp), de sorte 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 enregistrées
Section intitulée « Gérer les informations de connexion sauvegardées »# List saved credentialsbunx @capgo/cli build credentials list
# Update a specific option without re-entering everythingbunx @capgo/cli build credentials update --skip-build-number-bump
# Clear saved credentialsbunx @capgo/cli 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 build request --platform ios env: CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }} BUILD_CERTIFICATE_BASE64: ${{ secrets.IOS_CERTIFICATE }} BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.IOS_PROFILE }} 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 }} APPLE_PROFILE_NAME: ${{ secrets.APPLE_PROFILE_NAME }} 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 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 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 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 build credentials save --platform ios \ --certificate ./cert.p12 \ --provisioning-profile ./profile.mobileprovision \ --output-upload
# Override specific options per-buildbunx @capgo/cli 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 drapeaux CLI définissent le comportement de construction pour cette exécution spécifique.