STEP:Versioning: Difference between revisions

From Step Mods | Change The Game
mNo edit summary
Line 6: Line 6:
* {{fc|green|Major}} - introduce new functionality, mod groups, guide section, tools, or methods. (e.g., changing from Wrye Bash to MO, adding a new tool, adding a new mod group, etc.)
* {{fc|green|Major}} - introduce new functionality, mod groups, guide section, tools, or methods. (e.g., changing from Wrye Bash to MO, adding a new tool, adding a new mod group, etc.)
* {{Fc|orange|Minor}} - changes to guide mod list or tool instructions. (e.g., adding/removing mods, changing selections in BethINI, etc.)
* {{Fc|orange|Minor}} - changes to guide mod list or tool instructions. (e.g., adding/removing mods, changing selections in BethINI, etc.)
* {{Fc|highlight|Hotfix}} - changes/fixes that require immediate remedial actions. (e.g., corrections to guide instructions, changes to mod install order, updates to mod instructions, Patch updates, etc.)
* {{Fc|highlight|Hotfix}} - changes/fixes that impact the Nexus files and require immediate remedial action. (e.g., Patch updates, asset changes, etc.)
** Hotfixes are typically released when a small collection of these "fixes" have accumulated. Until that time, changes will be reflected on the current Changelog.
** Hotfixes will always be indicated in the ''Post-Release Changes'' section at top of the current Changelog.
* If a guide version is in a pre-release state, the version number may have a 'b' suffix to indicate a 'beta' version state.


====Under this scheme====
====Under this scheme====
<p>'''Beta Versioning''': {{fc|green|0}}.{{Fc|orange|1}}.{{Fc|highlight|0}}</p>
* {{fc|green|Major}} is always {{fc|green|0}} when releases are in a beta state. Only a full release can trigger a change to {{fc|green|Major}}, at which point version defaults New Guide versioning.
<p>'''New Guide Versioning''': {{fc|green|1}}.{{Fc|orange|0}}.{{Fc|highlight|0}}</p>
<p>'''New Guide Versioning''': {{fc|green|1}}.{{Fc|orange|0}}.{{Fc|highlight|0}}</p>
* New guides start at the beginning of the versioning scheme.
* New guides start at the beginning of the versioning scheme.
<p>'''Beta Versioning''': {{fc|green|0}}.{{Fc|orange|1}}.{{Fc|highlight|0}}</p>
* {{fc|green|Major}} is always {{fc|green|0}} when releases are in a beta state. Only a full release can trigger a change to {{fc|green|Major}}, at which point version defaults New Guide versioning.
* The remainder of the scheme will remain the same.


===No Man's Sky Exception===
===No Man's Sky Exception===
Line 25: Line 23:
** {{fc|instruction|Game updates '''''without''''' a version name change (e.g., ''NMS:Sentinel v'''3.83''''' to ''NMS:Sentinel v'''3.84''''') are updated in-place and '''do not''' increment any version numbers.}}<br>This is due to HelloGames patch release conduct, which are quick and multiple patch releases following any major update (version name changes). It's common for these updates to happen twice a week or more, therefore these minor patch updates are handled without implementing a new guide version.
** {{fc|instruction|Game updates '''''without''''' a version name change (e.g., ''NMS:Sentinel v'''3.83''''' to ''NMS:Sentinel v'''3.84''''') are updated in-place and '''do not''' increment any version numbers.}}<br>This is due to HelloGames patch release conduct, which are quick and multiple patch releases following any major update (version name changes). It's common for these updates to happen twice a week or more, therefore these minor patch updates are handled without implementing a new guide version.


==Examples==
===Examples===
STEP Guide version example: {{fc|green|2}}.{{Fc|orange|9}}.{{Fc|highlight|2}}
STEP Guide version example: {{fc|green|2}}.{{Fc|orange|2}}.{{Fc|highlight|1}}
* {{fc|green|v2}} brought changes to mod sorting software, mod management software, and introduced alpha Pack support
* {{fc|green|v2}} brought changes to lighting, added post processing, and introduced methodological changes to the SkyrimSE guide.
* {{Fc|orange|v9}} constitutes nine changes to the mod lineup since the change to {{fc|green|v2}}.
* {{Fc|orange|v2}} constitutes two changes to the mod list since the change to {{fc|green|v2}}.
* {{Fc|highlight|v2}} constitutes two bug/hotfixes have been released since the last mod lineup change ({{Fc|orange|v9}}).
* {{Fc|highlight|v1}} indicates that a plugin was updated to address changes to a master plugin, and new DynDOLOD rules were added.


{{AlertSmall|type=notice|text=The following are only '''hypothetical examples''' to illustrate changes that would apply to a specific level of versioning.}}
== Nexus Version Maintenance ==
=====Skyrim Guides:=====
WIP
'''Skyrim  (current Skyrim STEP Guide version)''': {{fc|green|2}}.{{Fc|orange|9}}.{{Fc|highlight|2}}
* Switch to official Wrye Bash support: {{fc|green|3}}.{{Fc|orange|0}}.{{Fc|highlight|0}} (major changes resets minor/hotfix versions)
* Remove a mod or add new mods: {{fc|green|2}}.{{Fc|orange|10}}.{{Fc|highlight|0}} (minor changes resets hotfix version)
* Update mod installation instructions: {{fc|green|2}}.{{Fc|orange|9}}.{{Fc|highlight|3}}
* Separate Extended Pack from Core Guide AND change mod management software: {{fc|green|3}}.{{Fc|orange|0}}.{{Fc|highlight|0}}

Revision as of 03:20, January 17, 2023

Delta c.png

Step Versioning Scheme

Scheme used for official Step Game Guides

by: Step Modifications  | Forum Topic

Implemented as of Step SkyrimLE Guide v2.10.0

Major.Minor.Hotfix

  • Major - introduce new functionality, mod groups, guide section, tools, or methods. (e.g., changing from Wrye Bash to MO, adding a new tool, adding a new mod group, etc.)
  • Minor - changes to guide mod list or tool instructions. (e.g., adding/removing mods, changing selections in BethINI, etc.)
  • Hotfix - changes/fixes that impact the Nexus files and require immediate remedial action. (e.g., Patch updates, asset changes, etc.)
    • Hotfixes will always be indicated in the Post-Release Changes section at top of the current Changelog.

Under this scheme

Beta Versioning: 0.1.0

  • Major is always 0 when releases are in a beta state. Only a full release can trigger a change to Major, at which point version defaults New Guide versioning.

New Guide Versioning: 1.0.0

  • New guides start at the beginning of the versioning scheme.

No Man's Sky Exception

Since No Man's Sky is not a Bethesda game it has slightly different rules regarding incrementing Minor versions. The following will cause an increment:

  • changes to guide mod list or tool instructions (e.g., adding/removing mods, switching a mod from MO installation to AMUMSS, etc.)
  • changes to the game's version name (e.g., NMS:Frontiers becomes NMS:Expeditions, NMS:Sentinel becomes NMS:Outlaws, etc.)
    • Expedition updates do not trigger Minor version updates
    • Game updates without a version name change (e.g., NMS:Sentinel v3.83 to NMS:Sentinel v3.84) are updated in-place and do not increment any version numbers.
      This is due to HelloGames patch release conduct, which are quick and multiple patch releases following any major update (version name changes). It's common for these updates to happen twice a week or more, therefore these minor patch updates are handled without implementing a new guide version.

Examples

STEP Guide version example: 2.2.1

  • v2 brought changes to lighting, added post processing, and introduced methodological changes to the SkyrimSE guide.
  • v2 constitutes two changes to the mod list since the change to v2.
  • v1 indicates that a plugin was updated to address changes to a master plugin, and new DynDOLOD rules were added.

Nexus Version Maintenance

WIP

Retrieved from "https://stepmodifications.org/wiki/index.php?title=STEP:Versioning&oldid=182283"