From 7b360e98c28a5c30590b870c021a60a7d1974580 Mon Sep 17 00:00:00 2001 From: Rob B Date: Mon, 27 Jan 2025 01:43:44 -0500 Subject: [PATCH] Fix #360 by adding semver prerelease info --- .../pages/Development/BeginnersGuide/ReleaseMod.adoc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/Development/BeginnersGuide/ReleaseMod.adoc b/modules/ROOT/pages/Development/BeginnersGuide/ReleaseMod.adoc index fbb17b35..92732a55 100644 --- a/modules/ROOT/pages/Development/BeginnersGuide/ReleaseMod.adoc +++ b/modules/ROOT/pages/Development/BeginnersGuide/ReleaseMod.adoc @@ -125,7 +125,7 @@ Below is a description of all extra fields SML and SMR require: |SemVersion | Version number for the mod. Should always increase with new releases, and should follow the https://semver.org/[semver] format. -To summarize, the format is `Major.Minor.Patch` +To summarize, the format is `Major.Minor.Patch`. {blank} + {blank} + As a rule of thumb, version `1.0.0` should be used for the first public release of your mod. @@ -141,6 +141,13 @@ so you should try to avoid this. or break how other mods interact with your mod, you should increase the Major version, for example `2.0.0`. +If you wish to release a pre-release version of your mod, +use the extended `Major.Minor.Patch-PrereleaseString` format, +where `PrereleaseString` is an +https://semver.org/#spec-item-9[alphanumeric-and-dash] string of your choice, such as `pre1`. +The Mod Manager does not automatically download any versions with a prerelease suffix - +the user must manually select that version from the version picker. + {blank} + Note that `1.10.0` is a valid semver version, `2.0.0` does not necessarily have to come after `1.9.0`.