summaryrefslogtreecommitdiff
path: root/docs/technical/smapi.md
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-12-03 02:16:27 -0500
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-12-03 02:16:27 -0500
commite4416925f9b4d1deac521c62918d008076ac6b05 (patch)
treeb882f3225a6ad05b995bca373513fce107e6b8ce /docs/technical/smapi.md
parent181508084b5bb2bb7b8cd61ec3193a293300ba45 (diff)
downloadSMAPI-e4416925f9b4d1deac521c62918d008076ac6b05.tar.gz
SMAPI-e4416925f9b4d1deac521c62918d008076ac6b05.tar.bz2
SMAPI-e4416925f9b4d1deac521c62918d008076ac6b05.zip
add build script to set the release version
Diffstat (limited to 'docs/technical/smapi.md')
-rw-r--r--docs/technical/smapi.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/technical/smapi.md b/docs/technical/smapi.md
index ce1220f1..f2e030d8 100644
--- a/docs/technical/smapi.md
+++ b/docs/technical/smapi.md
@@ -116,16 +116,15 @@ To launch the game:
2. Launch the game through the Steam UI.
#### Prepare the release
-1. Update the version numbers in `build/common.targets`, `Constants`, and the `manifest.json` for
- bundled mods. Make sure you use a [semantic version](https://semver.org). Recommended format:
+1. Run `build/set-smapi-version.sh` to set the SMAPI version. Make sure you use a [semantic
+ version](https://semver.org). Recommended format:
build type | format | example
:--------- | :----------------------- | :------
- dev build | `<version>-alpha.<date>` | `3.0.0-alpha.20171230`
- prerelease | `<version>-beta.<date>` | `3.0.0-beta.20171230`
- release | `<version>` | `3.0.0`
-2. Run the `build/prepare-install-package.sh` script. This will create the release package in the
- root `bin` folder.
+ dev build | `<version>-alpha.<date>` | `4.0.0-alpha.20251230`
+ prerelease | `<version>-beta.<date>` | `4.0.0-beta.20251230`
+ release | `<version>` | `4.0.0`
+2. Run `build/prepare-install-package.sh` to create the release package in the root `bin` folder.
### Custom Harmony build
SMAPI uses [a custom build of Harmony](https://github.com/Pathoschild/Harmony#readme), which is