Riktlinjer för versionsnummer¶
Blender Extensions-plattformen kräver inte något särskilt versionsnumreringssystem, så om du redan har ett versionshanteringssystem som du använder för ditt tillägg, är du välkommen att fortsätta använda det.
Om du inte har ett befintligt system för versionsnumrering rekommenderar vi dock att du följer riktlinjerna nedan.
Add-on-tillägg¶
Tillägg bör följa semantisk versionshantering i andan.
Semantisk versionshantering utformades för programvarubibliotek med API:er, och det är inte (vanligtvis) vad tillägg är. Tillägg tillhandahåller snarare funktionalitet som vänder sig till användaren, och därför är semantisk versionering inte strikt tillämplig.
Vi rekommenderar dock att man följer andan i semantisk versionshantering med tillägg på följande sätt:
Versionsnummer bör använda formatet MAJOR.MINOR.PATCH (t.ex. 2.3.1).
MAJOR-numret bör ökas för ändringar som tar bort eller ändrar befintlig funktionalitet på ett sådant sätt att användarna inte bara kan fortsätta att använda tillägget som tidigare. Tumregler:
Om den nya versionen inte fungerar med data som skapats för/av den tidigare versionen, ökar du MAJOR-numret.
Om användaren behöver lära sig något icke-trivialt om tillägget för att kunna fortsätta använda det som tidigare, ökas MAJOR-numret.
MINOR-numret bör ökas när ny funktionalitet införs, men utan att befintlig funktionalitet påverkas i någon större utsträckning. En tumregel:
Om ny funktionalitet har införts, men användaren helt enkelt kan ignorera den (om så önskas) och fortsätta arbeta med tillägget på samma sätt som tidigare, ökar du MINOR-numret.
PATCH-numret bör ökas för buggfixar och små ändringar som inte påverkar tilläggets avsedda funktionalitet. En tumregel:
Om den nya versionen inte skiljer sig nämnvärt från ett slutanvändarperspektiv, bortsett från buggfixar, ökar du PATCH-numret.
Dessa riktlinjer täcker inte alla tänkbara situationer, men förhoppningsvis ger de en god uppfattning om hur man bör hantera de vanligaste fallen. Utvecklare av tillägg bör använda sitt bästa omdöme när de hanterar situationer som inte täcks väl av dessa riktlinjer.
Tematillägg¶
Tematillägg har inte samma överväganden som tilläggstillägg och behöver därför inte följa något som semantisk versionshantering. Istället rekommenderar vi att du följer dessa riktlinjer:
Versionsnumren ska vara i formatet X.Y.Z (t.ex. 2.3.1).
X bör ökas för ”väsentliga” visuella förändringar eller omarbetningar av temat.
Y ska användas för ”spår” av temat för olika Blender-versioner (se nedan).
Z ska ökas för mindre visuella justeringar eller visuella ”buggfixar”.
Spår¶
Nya Blender-versioner kan ibland introducera förändringar i Blenders Python API eller till och med ändra hur hela funktioner fungerar. Om detta påverkar ditt tillägg kanske du vill underhålla två ”spår” av ditt tillägg samtidigt: ett för Blender ”old” och ett för Blender ”new”.
Du kan använda versionsnumrering för att uppnå detta på ett rimligt tydligt sätt. Till exempel, om ditt tillägg för närvarande är version 1.2.1, och du vill släppa en ny version för de banbrytande ändringarna i Blender ”new”, kan du släppa den nya versionen som version 1.3.0. Om du sedan behöver göra buggfixar i versionen av tillägget för Blender ”old”, kan du fortfarande öka patchnumret till 1.2.2, 1.2.3, etc. I själva verket är 1.2.x och 1.3.x två olika ”spår” av tillägget, som var och en kan fortsätta att få nya utgåvor.
Alternativt kan du inkrementera huvudversionsnumret för spåren, särskilt om du förväntar dig att göra mer än bara buggfixar för de äldre spåren. I vilket fall som helst rekommenderar vi starkt att man inte bara ökar patchversionen för den här typen av uppdateringar: man vet aldrig när man kan behöva göra en buggfixrelease.
Observera
Se till att korrekt ange de Blender-versioner som varje version av ditt tillägg är kompatibelt med i deras manifestfil. Du kan också uppdatera Blender-versionskompatibiliteten för redan uppladdade versioner av ditt tillägg från tilläggets webbplats.