From a1e812f40c6deb3721aa0f36411fc499d92298e3 Mon Sep 17 00:00:00 2001
From: GeckoEidechse <gecko.eidechse+git@pm.me>
Date: Thu, 16 Jun 2022 18:09:37 +0200
Subject: Add information on how to make a new release

---
 .../development/releases.md                        | 45 ++++++++++++++++++++++
 1 file changed, 45 insertions(+)

(limited to 'docs')

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.
-- 
cgit v1.2.3