Passer au contenu principal
Nous estimons que la gestion des versions est un aspect essentiel de notre offre et nous nous efforçons d’appliquer une stratégie cohérente de gestion des versions à nos produits afin d’aider nos utilisateurs à gérer et à anticiper l’incidence de nos changements sur leur utilisation.

Versionnage sémantique

Le versionnage sémantique (aussi appelé semver) est une stratégie de gestion des versions dont la principale caractéristique est de rendre les changements incompatibles repérables. Une version se compose de 3 nombres séparés par des points : ... Par exemple, 2.12.5, 0.1.0 et 10.5.35 sont des versions semver valides.
  • Le premier nombre représente un changement majeur : l’API de la bibliothèque a changé d’une manière non rétrocompatible. Lorsqu’on incrémente la partie majeure d’une version, l’API publique de cette bibliothèque a changé. Par exemple, du code et des fonctionnalités auparavant marqués comme obsolètes sont retirés de la base de code.
  • Le deuxième nombre représente un changement mineur : de nouvelles fonctionnalités sont ajoutées à l’API de la bibliothèque, ou certaines sont marquées comme obsolètes, tout en conservant la rétrocompatibilité. La nouvelle version mineure devrait pouvoir être utilisée sans risque, et nous encourageons les clients à effectuer la mise à jour. Cependant, puisqu’il est impossible de connaître toutes les façons dont les clients utilisent un composant, il demeure possible que ces changements aient une incidence sur son utilisation actuelle. Par conséquent, nous recommandons de vérifier et de tester avant d’effectuer une mise à jour.
  • Le troisième nombre représente un correctif : un bogue a été corrigé et cela ne devrait avoir aucune incidence sur l’API publique. La mise à jour devrait être sans risque, mais il est toujours recommandé d’effectuer des tests.

Utilisation en production

Auth0 fournit des liens vers notre Content Delivery Network (CDN), où nous hébergeons certaines de nos bibliothèques. La façon dont vous référencez un composant dans votre code déterminera si, et à quel moment, vous recevrez automatiquement les mises à jour. Par exemple, si vous pointez vers la version majeure dans un script et qu’une nouvelle version mineure est publiée, vous obtiendrez la mise à jour dès sa publication. Nous recommandons cette approche dans les environnements de développement et pour expérimenter avec Auth0. Voici des exemples d’inclusion des fichiers source :
<!-- version majeure -->
<script src="https://cdn.auth0.com/example/1/library.js"></script>

<!-- version mineure -->
<script src="https://cdn.auth0.com/example/1.0/library.js"></script>

<!-- version corrective (recommandée pour la production) -->
<script src="https://cdn.auth0.com/example/1.0.1/library.js"></script>
Lorsque des composants Auth0 sont déployés en production, nous encourageons nos utilisateurs à se fixer sur une version précise et à effectuer des tests approfondis avec cette version. Même si l’ajout de nouvelles fonctionnalités de manière rétrocompatible ne devrait pas casser votre code, les interactions liées au comportement du composant peuvent être difficiles à prévoir. Même des correctifs mineurs peuvent modifier certaines hypothèses que vous faisiez au sujet du composant et qui peuvent ne plus être valides. Chaque composant open source d’Auth0 qui suit semver aura un tag correspondant à une version publiée dans son dépôt Git. Comme certains projets utilisent les outils npm pour publier des versions, les tags auront la lettre v comme préfixe. Par exemple, le tag de la version 5.2.3 sera v5.2.3.

Pour en savoir plus