Directives relatives au numéro de version

La plate-forme Blender Extensions n’impose aucun schéma de numérotation de version particulier, donc si vous avez déjà un schéma de version que vous utilisez pour votre extension, n’hésitez pas à continuer à l’utiliser.

Toutefois, si vous ne disposez pas d’un schéma de numérotation de version existant, nous vous recommandons de suivre les instructions ci-dessous.

Add-on extension

Les add-ons doivent suivre la gestion sémantique des versions dans l’esprit.

La gestion sémantique des versions a été conçue pour les bibliothèques de logiciels avec des API, et ce n’est pas (généralement) ce que sont les add-ons. Au contraire, les add-ons fournissent des fonctionnalités destinées à l’utilisateur, et donc la gestion sémantique des versions ne s’applique pas strictement.

Néanmoins, nous vous recommandons de suivre l’esprit de la gestion sémantique des versions avec des add-ons de la manière suivante :

  • Les numéros de version doivent utiliser le format MAJOR.MINOR.PATCH (par exemple 2.3.1).

  • Le numéro MAJOR doit être incrémenté pour les modifications qui suppriment ou modifient des fonctionnalités existantes de telle sorte que les utilisateurs ne peuvent pas simplement continuer à utiliser le module complémentaire comme il l’était auparavant. Règles de base :

    • Si la nouvelle version ne fonctionne pas avec les données créées pour/par la version précédente, incrémenter le numéro MAJOR.

    • Si l’utilisateur a besoin de réapprendre quelque chose de non trivial sur l’add-on pour continuer à l’utiliser comme il l’était déjà, incrémenter le nombre MAJOR.

  • Le numéro MINOR doit être incrémenté lors de l’introduction d’une nouvelle fonctionnalité, mais sans affecter de manière significative la fonctionnalité existante. Règle de base :

    • Si une nouvelle fonctionnalité a été introduite, mais que l’utilisateur peut simplement l’ignorer (s’il le souhaite) et continuer à travailler avec l’add-on comme il l’était déjà, incrémenter le nombre MINOR.

  • Le numéro PATCH doit être incrémenté pour les corrections de bogues et les petites modifications qui n’affectent pas les fonctionnalités prévues de l’extension. Règle de base :

    • Si la nouvelle version n’est pas sensiblement différente du point de vue de l’utilisateur final, à part les corrections de bogues, incrémenter le numéro PATCH.

Ces directives ne couvriront pas toutes les situations possibles, mais j’espère qu’elles donnent une bonne idée de la façon d’aborder les cas courants. Les développeurs d’extensions doivent faire preuve de discernement lorsqu’ils traitent des situations qui ne sont pas bien couvertes par ces directives.

Theme Extensions

Les extensions de thème n’ont pas les mêmes considérations que les extensions complémentaires et n’ont donc pas besoin de suivre quoi que ce soit comme la gestion sémantique des versions. Au lieu de cela, nous vous recommandons de suivre ces directives :

  • Les numéros de version doivent utiliser un format X.Y.Z (par exemple 2.3.1).

  • X doit être incrémenté pour les changements visuels “substantiels” ou les refontes du thème.

  • Y doit être utilisé pour les “pistes” du thème pour les différentes versions de Blender (voir ci-dessous).

  • Z doit être incrémenté pour des ajustements visuels mineurs ou des “corrections de bugs” visuels.

Tracks

Les nouvelles versions de Blender peuvent parfois introduire des changements cassants dans l’API Python de Blender ou même changer le fonctionnement de fonctionnalités entières. Si cela affecte votre extension, vous pouvez vouloir maintenir deux “pistes” de votre extension en même temps : une pour le Blender “ancien” et une pour le Blender “nouveau”.

Vous pouvez utiliser la numérotation de version pour y parvenir de manière raisonnablement claire. Par exemple, si votre extension est actuellement sur la version 1.2.1, et que vous souhaitez publier une nouvelle version pour les changements cassants dans Blender “new”, vous pouvez publier cette nouvelle version en tant que version 1.3.0. Ensuite, si vous avez besoin de faire des corrections de bugs dans la version de l’extension pour Blender “old”, vous pouvez toujours incrémenter le numéro de patch à 1.2.2, 1.2.3, etc. En effet, 1.2.x et 1.3.x sont deux “pistes” différentes de l’extension, chacune d’entre elles pouvant continuer à recevoir de nouvelles versions.

Alternativement, vous pouvez incrémenter le numéro de version majeur pour les pistes, en particulier si vous prévoyez de faire plus que de simples corrections de bogues pour les pistes plus anciennes. Quoi qu’il en soit, nous vous déconseillons fortement de n’incrémenter la version du correctif que pour ce type de mises à jour : vous ne savez jamais quand vous devrez peut-être publier une correction de bogue.

Note

Assurez-vous d’indiquer correctement les versions de Blender avec lesquelles chaque version de votre extension est compatible dans leur fichier manifeste. Vous pouvez également mettre à jour la compatibilité des versions Blender des versions déjà téléchargées de votre add-on à partir du site Web des extensions.