Usmernenia k číslu verzie¶
Platforma Blender Extensions nepredpisuje žiadnu konkrétnu schému číslovania verzií, takže ak už máte schému číslovania verzií, ktorú používate pre svoje rozšírenie, môžete ju používať aj naďalej.
Ak však nemáte existujúcu schému číslovania verzií, odporúčame postupovať podľa nižšie uvedených pokynov.
Rozšírenia doplnkov¶
Doplnky by sa mali riadiť v duchu sémantického vytvárania verzií.
Sémantické vytváranie verzií bolo navrhnuté pre softvérové knižnice s rozhraniami API a to nie sú (zvyčajne) doplnky. Doplnky poskytujú skôr funkcie zamerané na užívateľa, a preto sa na nich sémantické vytváranie verzií striktne nevzťahuje.
Napriek tomu odporúčame nasledovať ducha sémantického vytvárania verzií pomocou doplnkov nasledujúcim spôsobom:
Čísla verzií by mali používať formát MAJOR.MINOR.PATCH (napr. 2.3.1).
Číslo MAJOR by sa malo zvýšiť v prípade zmien, ktoré odstraňujú alebo menia existujúcu funkčnosť takým spôsobom, že používatelia nemôžu jednoducho pokračovať v používaní doplnku tak, ako predtým. Pravidlá:
Ak nová verzia nefunguje s údajmi vytvorenými pre predchádzajúcu verziu, zvýšte číslo MAJOR.
Ak sa užívateľ musí znovu naučiť niečo netriviálne o doplnku, aby ho mohol ďalej používať tak, ako doteraz, zvýšte číslo MAJOR.
Číslo MINOR by sa malo zvyšovať pri zavádzaní nových funkcií, ale bez výrazného vplyvu na existujúce funkcie. Pravidlo:
Ak bola zavedená nová funkcia, ale užívateľ ju môže jednoducho ignorovať (ak si to želá) a pokračovať v práci s doplnkom ako doteraz, zvýšte číslo MINOR.
Číslo PATCH by sa malo zvyšovať v prípade opráv chýb a malých zmien, ktoré nemajú vplyv na zamýšľanú funkčnosť doplnku. Pravidlo:
Ak sa nová verzia z pohľadu koncového užívateľa okrem opráv chýb výrazne nelíši, zvýšte číslo PATCH.
Tieto usmernenia nepokrývajú všetky možné situácie, ale dúfame, že poskytujú dobrý prehľad o tom, ako pristupovať k bežným prípadom. Vývojári rozšírení by mali pri riešení situácií, ktoré nie sú dobre pokryté týmito usmerneniami, postupovať podľa vlastného uváženia.
Rozšírenia motívu¶
Rozšírenia motívov nemajú rovnaké požiadavky ako rozšírenia doplnkov, a preto sa nemusia riadiť ničím podobným ako sémantickým vytváraním verzií. Namiesto toho odporúčame dodržiavať tieto pokyny:
Čísla verzií by mali byť vo formáte X.Y.Z (napr. 2.3.1).
X by sa malo zvýšiť v prípade „podstatných“ vizuálnych zmien alebo prepracovania témy.
Y by sa malo použiť pre „stopy“ témy pre rôzne verzie Blenderu (pozri nižšie).
Z by sa malo zvýšiť pre drobné vizuálne úpravy alebo opravy vizuálnych „chýb“.
Stopy¶
Nové verzie Blenderu môžu niekedy zaviesť prelomové zmeny v API Blenderu v jazyku Python alebo dokonca zmeniť fungovanie celých funkcií. Ak sa to týka vášho rozšírenia, možno budete chcieť súčasne udržiavať dve „stopy“ svojho rozšírenia: jednu pre Blender „starý“ a druhú pre Blender „nový“.
Na dosiahnutie tohto cieľa môžete použiť číslovanie verzií pomerne jasným spôsobom. Napríklad, ak je vaše rozšírenie v súčasnosti vo verzii 1.2.1 a chcete vydať novú verziu pre prelomové zmeny v „novom“ Blenderi, môžete túto novú verziu vydať ako verziu 1.3.0. Potom, ak potrebujete vykonať opravy chýb vo verzii rozšírenia pre „starý“ Blender, môžete stále zvyšovať číslo opravy na 1.2.2, 1.2.3 atď. V skutočnosti sú 1.2.x a 1.3.x dve rôzne „stopy“ rozšírenia, z ktorých každá môže naďalej dostávať nové vydania.
Prípadne môžete zvýšiť číslo hlavnej verzie pre stopy, najmä ak očakávate, že pre staršie stopy urobíte viac než len opravy chýb. V každom prípade dôrazne neodporúčame zvyšovať iba verziu opravy pre tento druh aktualizácií: nikdy neviete, kedy budete potrebovať vydať opravu chyby.
Poznámka
Uistite sa, že ste v súbore manifest správne uviedli verzie Blenderu, s ktorými je každá verzia vášho rozšírenia kompatibilná. Kompatibilitu s verziami Blenderu už nahraných verzií vášho doplnku môžete aktualizovať aj na webovej stránke rozšírenia.