Провідні Принципи Номерів Версій¶
Blender платформа Розширень не наказує використовувати якусь певну схему нумерування версій, то якщо, ви вже маєте якусь схему нумерування версій яку ви використовуєте для вашого розширення, можете і надалі її використовувати.
Однак, якщо ви не маєте наявної схеми нумерування версій, ми рекомендуємо слідувати принципам нижче.
Додаткові Розширення¶
Звичайні розширення повинні слідувати semantic versioning з душею.
Семантичне версіювання було створено для програмного забезпечення з APIs, і це є не те, що (типово) якими звичайні розширення є. Швидше за все, доповнення забезпечують функціональність, орієнтовану на користувача, і тому семантичне версіювання не дуже застосовується.
Тим не менш, ми рекомендуємо слідувати духу семантичного версіювання з розширеннями наступним шляхом:
Номери версій повинні використовувати MAJOR.MINOR.PATCH формат (приклад 2.3.1).
The MAJOR номер повинен бути збільшений для змін, що вилучають чи копіюють наявну функціональність в такий самий спосіб, що користувачі можуть просто продовжити користуватись розширенням як вони це робили раніше. Емпіричні правила:
Якщо нові версії не працюють з даними створеними для/за допомогою минулої версії, треба збільшити MAJOR номер.
Якщо користувачу треба вивчити щось не тривіальне про звичайне розширення, щоб продовжити використовувати його так як і раніше, треба збільшити MAJOR номер.
The MINOR число повинно бути збільшено коли представляється нова функціональність, але без значного впливу на наявну функціональність. Емпіричне правило:
Якщо було представлено нову функціональність, але користувач може просто проігнорувати її (якщо захоче) та продовжить працювати з розширенням так як і раніше, треба збільшити MINOR число.
The PATCH число повинно збільшуватись для налагодження помилок та маленьких змін які не впливають на призначену розширенням функціональність. Емпіричне правило:
Якщо, нова версія не є видимою з перспективи користувача, не рахуючи лагодження помилок, треба збільшити PATCH число.
Ці принципи не покриють кожну можливу ситуацію, але з надією на те, що вони нададуть гарного відчуття як знайти підхід до звичайних випадків. Розробники розширення повинні використовувати своє найкраще судження коли будуть шукати підхід в ситуаціях не добре покритих цими принципами.
Розширення Тем¶
Розширення тем не мають такого самого міркування як звичайні додаткові розширення, і тому не повинні слідувати будь-кому крім семантики версіювання. Натомість, ми рекомендуємо слідувати цим принципам:
Числа версій повинні використовувати X.Y.Z формат (приклад 2.3.1).
X повинен збільшуватись для «суттєвих» візуальних змін або перероблень теми.
Y повинен використовуватись для «треків» теми для різних версій Blender (дивіться нижче).
Z повинно збільшуватись для маленьких візуальних змін або візуальних лагоджень «помилок».
Tracks – Відстеження¶
Нова версія Blender може іноді представляти зміни, що можуть щось зламати в Blender’s Python API або навіть такі зміни, як вся функція повністю працює. Якщо це впливає на розширення, ви можливо захочете підтримувати два «трека» вашого розширення на зараз: одне для «старого» Blender та одне для «нового» Blender.
Ви можете використовувати числа версіювання, щоб завершити це прийнятним шляхом. Наприклад, якщо ваше розширення на зараз має версію 1.2.1, і ви бажаєте зробити випуск нової версії для змін в «новому» Blender які могли щось зламати, ви можете зробити випуск нової версії з номером 1.3.0. Потім якщо вам треба полагодити помилки в вашій версії для «старої» версії Blender, ви ще можете збільшувати номер патчу до 1.2.2, 1.2.3, і т.д. В цьому випадку, 1.2.x nf 1.3.x є двома різними «треками» розширення, кожний може продовжувати робити нові випуски.
Альтернативно, ви можете збільшувати номер major версії для треків, зокрема якщо ви очікуєте зробити більше чим просто полагодити помилки для старих треків. В іншому випадку, ми сильно рекомендуємо не збільшувати лише патч версію для цих оновлень: ви ніколи не знаєте коли вам знадобиться зробити випуск з полагодженими помилками.
Примітка
Переконайтесь в тому, що ви правильно вказуєте версії Blender так, що кожна версія вашого розширення є сумісною з їх маніфест файлом. Ви також можете оновити версію Blender для сумісності вже завантаженої версії вашого додаткового розширення з вебсайту розширень.