Intégration CI/CD

Intégrer Capgo dans votre pipeline CI/CD vous permet de mettre en œuvre automatiquement le processus de construction et de déploiement de mises à jour de votre application. En exploitant les Capgo CLI et semantic-release, vous pouvez vous assurer de déploiements cohérents et fiables, et permettre une itération rapide.

Avantages de l'intégration CI/CD

• L'automatisation: Pas plus de étapes manuelles ou de place pour les erreurs humaines. Votre processus de construction, de test et de déploiement peut être automatisé de bout en bout.

• Consistance: Chaque déploiement suit le même ensemble d'étapes, garantissant un processus prévisible et répétable. C'est particulièrement précieux lorsque vous avez plusieurs membres d'équipe contribuant code.

• Révisions plus rapides: Avec des déploiements automatisés, vous pouvez envoyer des mises à jour plus fréquemment et avec confiance. Pas plus d'attente pour les tests de qualité ou les approbations de publication.

Capgo CLI

Le Capgo CLI est la clé pour intégrer Capgo dans votre flux de travail CI/CD. Il fournit des commandes pour pousser de nouvelles versions de bundles, gérer les canaux, et plus encore.

La commande la plus importante pour l'intégration CI/CD est bundle upload:

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY

Si vous utilisez l'encryption, vous devez le fournir d'une des manières suivantes :

En utilisant un chemin de fichier de clé privée :

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-v2 PRIVATE_KEY_PATH

En utilisant le contenu de la clé privée directement (recommandé pour CI/CD) :

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-data-v2 PRIVATE_KEY_CONTENT

En utilisant les variables d'environnement (meilleure pratique pour CI/CD) :

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-data-v2 "$CAPGO_PRIVATE_KEY"

Configuration des variables d'environnement pour la cryptage

Pour les environnements CI/CD, il est recommandé de stocker votre clé privée comme une variable d'environnement plutôt qu'en fichier. Voici comment la configurer :

1. Obtenez le contenu de votre clé privée :

   cat .capgo_key_v2 | pbcopy

   Cela copie le contenu de la clé dans votre presse-papiers.

2. Ajoutez-le à votre environnement CI/CD :

   • GitHub Actions: Ajouter CAPGO_PRIVATE_KEY à vos secrets de repository
   • GitLab CI: Ajoutez-le sous forme de variable masquée dans vos paramètres de projet
   • CircleCI: Ajoutez-le sous forme de variable d'environnement dans vos paramètres de projet
   • Jenkins: Ajoutez-le sous forme de texte secret de credenciaux

3. Utilisez-le dans votre pipeline :

   - run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

Note: Le --key-data-v2 flag permet de passer le contenu de la clé privée directement sous forme de chaîne, ce qui est parfait pour les variables d'environnement dans les pipelines CI/CD où vous ne souhaitez pas créer de fichiers temporaires.

Cette commande télécharge la dernière mise à jour web vers le canal spécifié. Vous allez généralement exécuter cette commande en dernier dans votre pipeline CI/CD, après que votre mise à jour web ait été exécutée avec succès.

Configuration de Capgo dans votre pipeline CI/CD

Même si les étapes exactes varieront en fonction de votre outil de choix CI/CD, le processus général pour intégrer Capgo ressemble à ceci :

1. Générez une clé API: Connectez-vous à l'interface de gestion Capgo et créez une nouvelle clé API . Cette clé sera utilisée pour authentifier le CLI dans votre environnement CI/CD. Gardez-la secrète et n'y commettez jamais dans votre dépôt !

2. Configurez le bundle upload commande: Ajoutez une étape à votre configuration CI/CD qui exécute la bundle upload commande avec les arguments appropriés :

   upload.yml

   - run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }}

   Remplacez Production avec le canal que vous souhaitez déployer ${{ secrets.CAPGO_API_KEY }} avec la variable d'environnement contenant votre clé API, et ajoutez --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}" si vous utilisez l'encryption.

3. Ajoutez l'étape après votre build web upload Assurez-vous que l'étape suivante se déclenche après que votre build web ait réussi. Cela vous garantit toujours de déployer votre dernière __CAPGO_KEEP_0__.Voici un exemple de configuration pour __CAPGO_KEEP_1__ Actions : upload step comes after your web build has completed successfully. This ensures you’re always deploying your latest code.\n Here’s an example configuration for GitHub Actions:\n

   Copier dans le presse-papier

   name: Deploy to Capgo
    on:
     push:
      branches: [main]
   
   jobs:
    deploy:
    runs-on: ubuntu-latest
   
    steps:
    - uses: actions/checkout@v6
    - uses: actions/setup-node@v6
     with:
      node-version: '24'
   
    - run: npm ci
    - run: npm run build
   
    - run: npm install -g @capgo/cli
    - run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

La façon recommandée de gérer la version avec __CAPGO_KEEP_0__ est de définir la version dans votre

La façon recommandée de gérer la version avec Capgo est de définir la version dans votre capacitor.config.ts file en important-le depuis package.json:

import pkg from './package.json'

const config: CapacitorConfig = {
  // ... other config
  plugins: {
    CapacitorUpdater: {
      version: pkg.version,
    }
  }
}

Cette approche vous permet :

1. Utiliser semantic-release (ou n'importe quel autre outil) pour mettre à jour le package.json version
2. Construire votre application avec la version mise à jour automatiquement incluse
3. Envoyer le bundle avec la version correcte

Votre flux de CI/CD ressemblerait à ceci :

- run: npm ci
- run: npx semantic-release  # Updates package.json version
- run: npm run build         # Builds with new version from capacitor.config
- run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }}

Voici un exemple .releaserc de fichier de configuration pour semantic-release :

{
  "branches": [
    "main",
    {
      "name": "beta",
      "prerelease": true
    }
  ],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    [
      "@semantic-release/git",
      {
        "assets": ["CHANGELOG.md", "package.json"],
        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
      }
    ]
  ]
}

Cette configuration effectue les opérations suivantes :

1. Analyse les messages de commit pour déterminer le prochain numéro de version, en suivant la spécification Conventional Commits.
2. Génère des notes de version basées sur les commits depuis la dernière version.
3. Mise à jour du fichier avec les nouvelles notes de version. CHANGELOG.md Mise à jour de la version, qui sera prise en compte par votre __CAPGO_KEEP_0__.config.
4. Commite les fichiers mis à jour, ainsi que tout autre fichier modifié, vers le dépôt. package.json Assurez-vous d'exécuter semantic-release avant de construire votre application afin que la version mise à jour de capacitor.config. soit incluse dans votre build.
5. Résolution des problèmes CHANGELOG.md, package.jsonRésolution des problèmes

Résolution des problèmes package.json is included in your build through the capacitor.config.

Résolution des problèmes

Si vous rencontrez des problèmes avec votre intégration CI/CD Capgo, voici quelques choses à vérifier :

• API clé: Assurez-vous que votre clé API est valide et dispose des autorisations nécessaires. Si vous utilisez une variable d'environnement, vérifiez à nouveau que celle-ci est correctement définie.

• CLI version: Assurez-vous d'utiliser la dernière version du Capgo CLI. Les versions plus anciennes peuvent présenter des problèmes de compatibilité ou manquer certaines fonctionnalités.

• Fichiers de build: Confirmez que votre build web génère les fichiers de sortie attendus. Le Capgo CLI nécessite un build web valide pour créer un bundle.

• Connexion réseau: Vérifiez que votre environnement CI/CD a accès au réseau pour se connecter aux serveurs Capgo. Des problèmes de pare-feu ou de proxy peuvent parfois entraver la upload commande.

Si vous rencontrez toujours des difficultés, contactez le support Capgo pour obtenir de l'aide. Ils peuvent vous aider à résoudre les problèmes liés à votre configuration spécifique.

Conclusion

Intégrer Capgo dans votre pipeline CI/CD avec une gestion de version appropriée peut considérablement simplifier votre flux de développement. En automatisant vos déploiements et la versionnage à l'aide de l'approche capacitor.config, vous pouvez déployer des mises à jour plus rapidement et avec plus de confiance.

La méthode recommandée consiste à définir la version dans votre capacitor.config.ts fichier et à utiliser semantic-release pour mettre à jour package.json ce qui fournit un processus de déploiement robuste et fiable qui vous permet de vous concentrer sur la création de grandes fonctionnalités plutôt que de vous soucier des étapes de libération manuelles.

Pour plus de détails sur les commandes et les options Capgo CLI , consultez la documentation de référence CLI . Et pour une approfondie de la configuration de semantic-release, voir lesdocs de semantic-release Joyeux déploiement !.

Continuez de l'intégration CI/CD

__CAPGO_KEEP_0__ __CAPGO_KEEP_1__

Si vous utilisez Intégration CI/CD pour planifier l'automatisation CI/CD, connectez-le avec Capgo Intégration CI/CD pour le flux de travail du produit dans Capgo Intégration CI/CD, Capgo Constructions natives pour le flux de travail du produit dans Capgo Constructions natives, Capgo Intégrations pour le flux de travail du produit dans Capgo Intégrations, GitHub Intégration d'actions pour le détail d'implémentation dans GitHub Intégration d'actions, et Intégration CI/CD de GitLab pour les détails d'implémentation dans l'intégration CI/CD de GitLab.