SemVer vs. CalVer : Quelle stratégie de versioning choisir ?

Comprendre le versioning logiciel : SemVer vs. CalVer

Lors de la gestion de projets logiciels, choisir la bonne stratégie de versioning est essentiel pour maintenir la stabilité, communiquer efficacement les changements et répondre aux besoins des développeurs et des utilisateurs. Deux des schémas de versioning les plus utilisés sont Semantic Versioning (SemVer) et Calendar Versioning (CalVer). Comprendre les différences entre ces deux méthodes aidera votre équipe à appliquer les meilleures pratiques et à garantir une maintenance durable.

Cet article examine les différences entre SemVer et CalVer, leurs cas d'utilisation et pourquoi leur combinaison stratégique peut être bénéfique pour vos applications Symfony, vos bibliothèques PHP et vos logiciels d'entreprise.

Qu'est-ce que le Semantic Versioning (SemVer) ?

Le Semantic Versioning (SemVer) suit un format structuré : MAJOR.MINOR.PATCH (ex : 1.4.2). Les principes fondamentaux du SemVer sont :

• MAJOR : incrémenté en cas de changements incompatibles de l’API.

• MINOR : incrémenté lors de l’ajout de nouvelles fonctionnalités compatibles.

• PATCH : incrémenté pour des corrections de bugs.

Pourquoi SemVer est-il nécessaire pour les bibliothèques et les API ?

Le SemVer définit des règles claires pour gérer les changements de rupture, en garantissant que les utilisateurs d’une bibliothèque ou d’un package comprennent l’impact des mises à jour. Il est largement utilisé pour les bibliothèques open source, les frameworks et les API, car :

• Les développeurs peuvent s'assurer qu'une mise à jour mineure ou corrective ne cassera pas leur implémentation.

• Il encourage la stabilité des API publiques en imposant des règles strictes d’évolution.

• Les gestionnaires de dépendances (Composer, NPM, pip) peuvent résoudre les mises à jour en toute sécurité.

Les cas d'utilisation recommandés du SemVer

• Les packages et bundles PHP (ex : les composants Symfony)

• Les APIs et les SDKs nécessitant une compatibilité ascendante stricte

• Les bibliothèques open source où le versioning structuré empêche les changements disruptifs

• Les frameworks dont d'autres applications dépendent

Dans un contexte PHP et Symfony, utiliser le SemVer garantit la stabilité de l'API, facilitant ainsi l’intégration des mises à jour sans risque de rupture.

Qu'est-ce que le Calendar Versioning (CalVer) ?

Le Calendar Versioning (CalVer) associe les numéros de version aux dates plutôt qu’aux modifications de l’API. Un format courant est YYYY.MM.PATCH (ex : 2024.1.0), où :

• YYYY représente l’année de sortie.

• MM représente le mois (ou X pour une version majeure).

• PATCH (optionnel) est un numéro incrémental pour les correctifs au sein d’un cycle de publication.

Les formats possibles du CalVer et leur utilité

Le CalVer offre une flexibilité dans la structuration des numéros de version avec plusieurs variantes :

• YYYY – Année complète (ex : 2006, 2016, 2106)

• YY – Année courte (ex : 6, 16, 106)

• 0Y – Année courte avec zéro (ex : 06, 16, 106)

• MM – Mois court (ex : 1, 2, 11, 12)

• 0M – Mois avec zéro (ex : 01, 02, 11, 12)

• WW – Semaine depuis le début de l'année (ex : 1, 2, 33, 52)

• 0W – Semaine avec zéro (ex : 01, 02, 33, 52)

• DD – Jour du mois (ex : 1, 2, 30, 31)

• 0D – Jour avec zéro (ex : 01, 02, 30, 31)

Quels sont les avantages du CalVer pour une application ?

Le CalVer synchronise le versioning aux cycles de publication au lieu de la compatibilité API. C'est utile pour :

• Les logiciels d’entreprise avec des sorties de nouvelles versions planifiées.

• Les plateformes SaaS évoluant en continu.

• Les applications internes qui privilégient des mises à jour régulières.

• Les systèmes d'exploitation (ex : Ubuntu 24.04 signifie avril 2024).

Les cas d'utilisation recommandés pour le CalVer

• Les applications web et plateformes (ex : des applications basées sur Symfony)

• Les logiciels métiers nécessitant des mises à jour fréquentes

• Les outils d’infrastructure (ex : Kubernetes, Docker, Terraform)

• Distributions OS (ex : Ubuntu, macOS, Windows)

Le CalVer permet de suivre facilement la date d'une version, ce qui aide les équipes à planifier et gérer les mises à jour efficacement.

Pourquoi utiliser le SemVer pour les bibliothèques et le CalVer pour les projets ?

Bien que ces stratégies aient des usages distincts, leur combinaison améliore la maintenabilité du logiciel.

 Utiliser le SemVer pour les bibliothèques, bundles et packages

• Assure une compatibilité ascendante et facilite la gestion des dépendances.

• Permet aux gestionnaires de paquets de résoudre les mises à jour en toute sécurité.

• Offre une approche structurée des changements d'API.

 Utiliser le CalVer pour les projets et applications

• Assure la synchronisation avec les calendriers de sortie de nouvelles versions.

• Facilite le suivi des versions Long-Term Support (LTS).

• Permet de planifier les mises à jour en fonction du temps plutôt qu’en fonction des changements d’API.

Un exemple dans un environnement Symfony

Imaginons une plateforme Symfony avec plusieurs bundles personnalisés :

• L'application principale utilise le CalVer (2024.2.0 pour février 2024).

• Les bundles Symfony personnalisés utilisent le SemVer (2.1.3 pour une mise à jour mineure avec corrections de bugs).

Cette approche garantit que les dépendances externes suivent des règles de versioning stables, tandis que l’application évolue selon un calendrier prévisible.

Conclusion : Quelle stratégie de versioning choisir ?

Choisir la bonne stratégie de versioning est essentiel pour assurer la maintenabilité des logiciels. Le SemVer est idéal pour les bibliothèques et packages, afin de garantir la stabilité et la compatibilité. Le CalVer est plus adapté aux applications et logiciels internes, en rendant les mises à jour plus prévisibles.

En combinant le SemVer pour les composants réutilisables et le CalVer pour les applications évolutives, vous conciliez stabilité et agilité, offrant ainsi une meilleure expérience aux développeurs et aux utilisateurs.