Gérer les changelogs est essentiel pour rester mises à jour d'app transparent et organisé. Ce guide explique comment créer, structurer et automatiser les changelogs pour apps Capacitor, afin que les développeurs et les utilisateurs soient informés. Voici ce que vous allez apprendre :
- Pourquoi les changelogs sont importantsIls simplifient le débogage, améliorent la communication et renforcent la confiance des utilisateurs.
- Comment structurer vos changelogs : Utilisez des catégories comme « Ajouté », « Corrigé » et « Sécurité » pour plus de clarté.
- Bonnes pratiques: Mettez à jour les changelogs avant les commits, automatisez avec des outils comme Capgo, et révisez les entrées lors des pull requests.
- Outils d'automatisation: Utilisez des pipelines CI/CD et des standards de commit pour simplifier la gestion des changelogs.
- Mises à jour OTA: Documentez les Live Update avec des détails tels que les numéros de version, les horodatages et les taux de réussite.
Astuce rapide: Automatisez la création de vos changelogs avec des outils comme Capgo pour gagner du temps et garantir la cohérence. 95 % des utilisateurs effectuent une mise à jour sous 24 heures grâce aux solutions de live update.
Plongez dans ce guide pour configurer votre premier changelog et l'intégrer parfaitement à votre workflow.
Comment versionner et générer automatiquement les changelogs de vos projets pour…
Configurer votre premier changelog
Créer un changelog clair est essentiel pour suivre et partager les mises à jour de votre application Capacitor. Voici comment le structurer efficacement et respecter les bonnes pratiques.
Options de format de changelog
Consultez la Maintenir un changelog standard pour organiser les mises à jour par version et par type. Cette approche utilise des catégories claires pour rendre les mises à jour faciles à comprendre :
| Catégorie | Description | Exemple d'entrée |
|---|---|---|
| Ajouté | Nouvelles fonctionnalités | Ajout du support des notifications push |
| Modifié | Mises à jour des fonctionnalités existantes | Flux d'authentification mis à jour |
| Déprécié | Fonctionnalités bientôt supprimées | Dépréciation des anciens endpoints API |
| Supprimé | Fonctionnalités supprimées | Suppression des analyses obsolètes |
| Corrigé | Bug fixes | Correction des permissions caméra sur iOS |
| Sécurité | Mises à jour de sécurité | Chiffrement des données amélioré |
Construire votre CHANGELOG.md
Pour configurer votre CHANGELOG.md, assurez-vous qu'il soit organisé de manière cohérente et facile à lire. Placez-l’à la racine de votre projet et incluez ces éléments principaux :
- Section d'en-tête: Ajoutez le nom de votre projet et une courte description.
- Blocs de version: Les mises à jour sont documentées selon la version sémantique (MAJOR.MINOR.PATCH).
- Dates de release: Utilisez le format ISO (AAAA-MM-JJ), comme
2025-03-27. - Catégories de changements: Regroupez les mises à jour sous les titres appropriés.
Listez toujours les versions par ordre chronologique inverse pour que les dernières mises à jour apparaissent en haut.
Intégrer le changelog au développement
Intégrer les mises à jour du changelog à votre workflow garantit une documentation précise et à jour. Voici quelques conseils pratiques :
- Mises à jour pré-commit: Mettez à jour le changelog avant de committer les changements code. Cela réduit le risque d'oublier des mises à jour importantes.
- Intégration automatisée : Des outils comme Capgo fonctionnent avec GitHub Actions GitHub, GitLab CI, et Jenkins [1] pour simplifier le processus de mise à jour de votre changelog.
- Processus de revueIntégrez la revue des entrées du changelog à votre processus de pull request. Cela garantit que les mises à jour sont exactes et approuvées avant la fusion.
Rédiger des entrées de changelog claires
Les entrées du changelog doivent trouver un équilibre entre précision technique et lisibilité, afin d'être utiles tant aux développeurs qu'aux utilisateurs.
Guide de style de rédaction
Respectez ces principes pour garantir des entrées de changelog claires et cohérentes :
- Écrire au présent de l'indicatif
- Commencer par des verbes d'action
- Être précis sur les changements effectués
- Mentionner les mises à jour de versions de dépendances
- Utiliser un jargon technique minimal
Exemples :
| Entrée peu claire | Entrée claire |
|---|---|
| Bugs corrigés | Correction du gel de l'aperçu caméra sur les appareils iOS 17.4 |
| Ajouts divers | Ajout du support de l'authentification biométrique pour Android |
| Modification de API | Update user profile endpoint to support new fields |
| Correctifs de sécurité | Patch SQLite Vulnérabilité d'injection dans la fonction de recherche |
Changement des types et catégories
Organisez vos mises à jour en catégories claires pour que les utilisateurs trouvent rapidement ce qui les intéresse. Voici un aperçu des catégories courantes :
- Ajouté: Introduit de nouvelles fonctionnalités
- Modifié: Mises à jour ou modifications de fonctionnalités existantes
- Déprécié: Indique les fonctionnalités prévues pour suppression
- Supprimé: Indique les fonctionnalités qui ont été retirées
- Corrigé: Résout des bugs ou des problèmes
- Sécurité: Concerne les correctifs ou mises à jour liés à des vulnérabilités de sécurité
Évaluez l'impact utilisateur lors de l'attribution des catégories. Par exemple, si un API central est mis à jour, listez-le dans « Changé » et fournissez les détails de migration si nécessaire. Pour les mises à jour majeures, liez la source pour plus de contexte.
Ajouter des liens de référence
Rendez votre changelog plus utile en liant les entrées à la documentation, aux issues ou aux commits pertinents :
1. Références d'issues
Liez directement les issues ou les pull requests de GitHub liées au changement :
- Fix iOS camera permissions dialog ([#234](https://github.com/your-repo/issues/234))2. Liens vers la documentation
Lors de l'introduction de nouvelles fonctionnalités ou de breaking changes, incluez des liens vers la documentation mise à jour :
- Add push notification support (See [Migration Guide](https://docs.example.com/push))3. Références de commits
Pour les mises à jour majeures, référez le commit spécifique :
- Update authentication flow (commit: `8f4d89b`)« Capgo est un outil indispensable pour les développeurs qui veulent gagner en productivité. Éviter la review pour un bugfix, c'est de l'or en barre. » - Bessie Cooper
Outils d'automatisation du changelog
Automatiser la création du changelog simplifie votre workflow et garantit une documentation cohérente des changements tout au long de votre projet Capacitor.
Meilleurs outils de changelog
Plusieurs outils permettent d'automatiser efficacement vos changelogs. Lors de votre choix, concentrez-vous sur ces fonctionnalités clés :
- Détection de version: Repère automatiquement les nouvelles releases
- Analyse des commits: Extrait les détails pertinents des messages de commit
- Capacités d'intégration: S'intègre parfaitement à votre pipeline CI/CD actuel
- Options de personnalisation: S'adapte aux besoins spécifiques de votre projet
Capgo facilite l'automatisation des changelogs en intégrant les Live Updates [1]. Avec plus de 750 apps en production et 23,5 millions de mises à jour livrées [1], il a prouvé sa fiabilité. Pour tirer le meilleur parti de ces outils, assurez-vous que vos messages de commit suivent une structure claire.
Standards de messages de commit
Utilisez ce format pour vos messages de commit :
[corps optionnel]
[footer optionnel]
Voici les types de commit les plus courants :
- feat: Pour l'introduction de nouvelles fonctionnalités
- fix: Pour la résolution de bugs
- docs: Pour les changements de documentation
- style: pour le formatage des mises à jour
- refactor: pour réorganiser code sans changer son comportement
- test: Pour ajouter ou mettre à jour des tests
- chore: pour les tâches de maintenance générale
Configuration du changelog CI/CD
En combinant des outils automatisés et des messages de commit standardisés, vous pouvez intégrer la génération de changelog dans votre pipeline CI/CD. Cette configuration garantit des mises à jour rapides et précises. Un pipeline bien configuré peut auto-générer des changelogs, vérifier le formatage des messages, mettre à jour la documentation et notifier votre équipe.
Les résultats parlent d'eux-mêmes : 95 % des utilisateurs actifs reçoivent des mises à jour en moins de 24 heures grâce au système de déploiement automatisé de Capgo [1].
Gestion des changelogs de Live Update OTA
La gestion des changelogs pour les mises à jour OTA demande une attention particulière car ces mises à jour sont déployées instantanément. Contrairement aux mises à jour classiques des stores que les utilisateurs téléchargent manuellement, les mises à jour OTA atteignent les appareils automatiquement. Une documentation claire et détaillée est donc essentielle pour maintenir la confiance des utilisateurs et garantir la transparence.
Documentation des mises à jour OTA
Lors de la gestion des Live Updates, il est important de documenter les détails clés tels que la version du bundle, la version de la mise à jour OTA, les horodatages de déploiement, les taux de réussite et les métriques d'adoption par les utilisateurs. Pour rendre le changelog facile à comprendre, organisez les mises à jour en catégories claires :
| Catégorie | Description | Exemple d'entrée |
|---|---|---|
| Correctifs critiques | Correctifs urgents pour les problèmes immédiats | “Fixed crash in user authentication flow” |
| Mises à jour de fonctionnalités | Fonctionnalités nouvelles ou améliorées | « Ajout du support du mode sombre pour le dashboard » |
| Performance | Améliorations de la vitesse et de l'optimisation | « Temps de chargement de l'app réduit de 40 % » |
| Sécurité | Mises à jour pour renforcer la sécurité | “Enhanced data encryption for file transfers” |
Capgo Gestion des mises à jour
Pour les live update OTA, une documentation détaillée est indispensable pour compléter votre stratégie de changelog. Capgo simplifie ce processus en suivant automatiquement les versions, en surveillant la performance des mises à jour, en journalisant les rollbacks et en enregistrant les déploiements par canal.
Un développeur gérant plus de 5 000 utilisateurs a partagé son expérience :
« Nous avons déployé des live update Capgo en production pour notre base de +5000 utilisateurs. Le fonctionnement est très fluide : presque tous nos utilisateurs sont à jour quelques minutes seulement après le déploiement de l'OTA sur @Capgo. » – colenso [1]
Meilleures pratiques pour la gestion des changelogs OTA:
- Enregistrez les changements dès qu'ils sont effectués.
- Suivez les mises à jour par canal pour gérer vos déploiements progressifs.
- Gardez un historique clair des rollbacks pour résoudre rapidement les problèmes.
Rodrigo Mantica souligne l'importance de cette approche :
« Nous pratiquons le développement agile et @Capgo est essentiel pour livrer en continu à nos utilisateurs ! » – Rodrigo Mantica [1]
Résumé
Pratiques clés pour la gestion des changelogs
Gérer efficacement les changelogs améliore la clarté et renforce la confiance des utilisateurs. Voici quelques pratiques essentielles :
| Pratique | Description | Impact |
|---|---|---|
| Suivi des versions | Suivez les numéros de version (app et OTA). | 82 % de taux de réussite global pour les mises à jour suivies [1] |
| Catégories de mises à jour | Classer les mises à jour par type (correctifs, fonctionnalités, sécurité). | 95 % des utilisateurs actifs se mettent à jour en 24 h [1] |
| Historique des déploiements | Documentez les horodatages, taux de réussite et métriques. | Permet le monitoring de 23,5 M de mises à jour [1] |
| Stratégie de rollback | Conservez les logs des versions précédentes avec l'intégration OTA. | Permet une récupération immédiate si nécessaire. |
Outils suggérés pour une meilleure gestion
Pour mettre en œuvre ces pratiques efficacement, l'utilisation des bons outils est cruciale. Les applications Capacitor modernes bénéficient d'outils comme Capgo, qui simplifie la gestion des changelogs avec des fonctionnalités telles que :
- Contrôle de version automatisé: Suivez et documentez vos mises à jour en toute fluidité via vos pipelines CI/CD.
- Analyses en temps réelSuivez les performances des mises à jour et les taux d'adoption des utilisateurs.
- Gestion des canaux: Activez les tests bêta et les déploiements progressifs pour des releases plus fluides.
Lors du choix d'outils pour la gestion de vos changelogs, privilégiez :
- Intégration fluide: La compatibilité avec vos workflows existants.
- Documentation détaillée : Suivi automatique des données de déploiement.
- Mises à jour utilisateur : Communication claire et directe sur les changements.
En combinant ces pratiques avec les bons outils, vous pouvez établir un système de changelog fiable qui favorise la livraison continue tout en informant vos utilisateurs.
« Nous pratiquons le développement agile et @Capgo est indispensable pour livrer en continu à nos utilisateurs ! » [1]
Continuer avec Capacitor Gestion du changelog : le guide ultime
Si vous utilisez Capacitor Gestion du changelog : le guide ultime pour planifier le rollback et le contrôle de version, connectez-l’à Rollbacks pour les détails d'implémentation dans Rollbacks, Ciblage de version pour les détails d'implémentation dans Version Targeting, Comportement de mise à jour pour les détails d'implémentation du comportement des mises à jour, bundle pour les détails d'implémentation du bundle, et Capgo Live Updates pour le workflow produit dans Capgo Live Updates.
