diff options
author | GeckoEidechse <gecko.eidechse+git@pm.me> | 2022-06-16 18:09:37 +0200 |
---|---|---|
committer | GeckoEidechse <gecko.eidechse+git@pm.me> | 2022-06-16 18:09:37 +0200 |
commit | a1e812f40c6deb3721aa0f36411fc499d92298e3 (patch) | |
tree | 585e0aba84236a5cb3dbe391747c92c9f14a509f | |
parent | fa8a82fd739872b2dabdec493d67dae1feca8718 (diff) | |
download | NorthstarWiki-a1e812f40c6deb3721aa0f36411fc499d92298e3.tar.gz NorthstarWiki-a1e812f40c6deb3721aa0f36411fc499d92298e3.zip |
Add information on how to make a new release
-rw-r--r-- | docs/modding-and-development/development/releases.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/modding-and-development/development/releases.md b/docs/modding-and-development/development/releases.md index 53d86ba..db3d545 100644 --- a/docs/modding-and-development/development/releases.md +++ b/docs/modding-and-development/development/releases.md @@ -6,3 +6,48 @@ description: >- # Releases +{% hint style="info" %} +WIP +{% endhint %} + +## General + +CI on Northstar release repo builds versioned release if tag is pushed. It checks Launcher and Mods for same tag and builds those versions. \ +Therefore make sure to push tags of Mods and Launcher first. + +CI also pushes release directly to Thunderstore if it does not contain the `-rcX` suffix. + +### Git commands for tags: + +**For release candidates:** + +``` +git tag vX.Y.Z-rcN +git push origin vX.Y.Z-rcN +``` + +Example: + +``` +git tag v1.8.0-rc1 +git push origin v1.8.0-rc1 +``` + +**For actual releases** + +``` +git tag vX.Y.Z +git push origin vX.Y.Z +``` + +Example: + +``` +git tag v1.8.0 +git push origin v1.8.0 +``` + +## Best practices: + +- Make at least one release candidate and test it before actual release. +- Release should also only ever be latest release candidate but tagged as release to avoid introducing new bugs. |