From 9b1656fe1fe5e758994e87a641dfb0e10ad184a9 Mon Sep 17 00:00:00 2001
From: Clemens <clemens.geibel@meissa-gmbh.de.de>
Date: Fri, 22 Sep 2023 11:21:27 +0200
Subject: [PATCH] Added release instruction

---
 doc/Releasing.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 doc/Releasing.md

diff --git a/doc/Releasing.md b/doc/Releasing.md
new file mode 100644
index 0000000..b4f09af
--- /dev/null
+++ b/doc/Releasing.md
@@ -0,0 +1,41 @@
+# Release process
+
+## ... for testing (snapshots)
+
+Make sure your clojars.org credentials are correctly set in your ~/.lein/profiles.clj file.
+
+``` bash
+git add .
+git commit
+```
+
+``` bash
+lein deploy # or lein deploy clojars
+```
+
+## ... for stable release
+
+Make sure tags are protected in gitlab:
+Repository Settings -> Protected Tags -> set \*.\*.\* as tag and save.
+
+``` bash
+git checkout main # for old projects replace main with master
+git add .
+git commit 
+```
+
+Execute tests
+
+``` bash
+shadow-cljs compile test
+node target/node-tests.js
+lein test
+```
+
+Release with type (NONE, PATCH, MINOR, MAJOR):
+``` bash
+RELEASE_TYPE=[TYPE] pyb prepare_release after_publish
+
+```
+
+Done.