Passer au contenu
Capgo

Mise à jour automatique

Ce mode permet aux développeurs d’utiliser capacitor-updater en mode auto-update et de pousser des mises à jour via les canaux Capgo ou équivalent

Prérequis

Assurez-vous que la version de votre application utilise https://semverorg/ avant d’utiliser l’auto-update de Capgo

C’est la convention utilisée pour gérer les versions dans Capgo

Il existe deux façons de définir la version dans votre application :

Nouvelle méthode : Utilisez le champ version dans votre fichier capacitorconfigjson

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true, // Active l'auto-update, true par défaut
      "appId": "comexampleapp", // Utilisé pour identifier l'application sur le serveur
      "version": "100" // Utilisé pour vérifier les mises à jour
    }
  }
}

Ces options seront utilisées par le plugin pour vérifier les mises à jour et par le CLI pour télécharger la version

Ancienne méthode : Dans 3 fichiers de votre projet :

  • packagejson dans version
  • android/app/buildgradle dans versionName
  • ios/App/Appxcodeproj/projectpbxproj dans CURRENT_PROJECT_VERSION

Tutoriels

Configurez votre application en 5 minutes

Mettez à jour vos applications Capacitor en toute transparence avec capacitor updater

Configurez votre CI en 5 minutes

Build et déploiement automatiques avec GitHub actions

Installation

Terminal window
npm install @capgo/capacitor-updater
npx cap sync

Introduction

Cliquez sur register pour créer votre compte

Le serveur vous permet de gérer les canaux, les versions et bien plus encore

autoUpdate utilisera les données de capacitorconfig pour identifier le serveur Capgo

Valider la version

Lorsque l’auto-update est configuré, vous devez notifier depuis JS que votre application est active et prête

Cela peut être fait en appelant notifyAppReady dans votre application

Faites-le le plus tôt possible

import { CapacitorUpdater } from '@capgo/capacitor-updater'


CapacitorUpdaternotifyAppReady()

Flux utilisateur

  1. L’utilisateur ouvre l’application, l’application interroge le serveur pour vérifier les mises à jour, si des mises à jour sont trouvées, elles seront téléchargées en arrière-plan
  2. L’utilisateur quitte l’application, la nouvelle version est définie comme active
  3. L’utilisateur ouvre à nouveau l’application, nous chargeons la nouvelle version active et la définissons par défaut
  4. Si notifyAppReady() est appelé, lorsque l’utilisateur quitte l’application, l’ancienne version est supprimée
  5. L’utilisateur continue le flux normal de l’application jusqu’au prochain cycle de mise à jour

Flux de développement

Lorsque vous développez de nouvelles fonctionnalités, assurez-vous de bloquer autoUpdate, car capgo écrasera constamment votre travail avec le dernier bundle de mise à jour Définissez autoUpdate sur false dans votre configuration Si pour une raison quelconque vous êtes bloqué sur une mise à jour, vous pouvez supprimer l’application et la réinstaller Assurez-vous de définir autoUpdate sur false dans votre configuration avant de le faire Puis reconstruisez-la avec Xcode ou Android Studio

Pour télécharger la version à chaque commit, configurez CI/CD avec ce guide

Build et déploiement automatiques avec GitHub actions

Événement Major Available

Lorsque disableAutoUpdateBreaking est défini sur true, vous pouvez écouter l’événement pour savoir quand l’application refuse de faire une mise à jour majeure

import { CapacitorUpdater } from '@capgo/capacitor-updater'


CapacitorUpdateraddListener('majorAvailable', (info: any) => {
  consolelog('majorAvailable was fired', infoversion)
})