From 289e2733afc1a5f0341af95404c7938ca87b6d72 Mon Sep 17 00:00:00 2001
From: StefMa <StefMaDev@outlook.com>
Date: Mon, 2 Oct 2023 15:08:36 +0200
Subject: [PATCH] Introduce continious releasing

---
 .github/workflows/publish.yml |  2 ++
 README.md                     | 24 +++++++++++++++++++++++-
 2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index bf4e48b..a9d5644 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -4,6 +4,8 @@ on:
   push:
     tags:
       - '*'
+    branches:
+      - 'main'
 
 jobs:
   publish-kmp-metadata:
diff --git a/README.md b/README.md
index e291f26..fef35dd 100644
--- a/README.md
+++ b/README.md
@@ -42,4 +42,26 @@ repositories {
 dependencies {
     implementation("com.ioki:lokalise-api:<latest-version>")
 }
-```
\ No newline at end of file
+```
+
+## Release
+
+### Continuous release
+
+By default, each merge to `main` will create a new `SNAPSHOT` release.
+If you want to use the latest and greatest use the `SNAPSHOT` version of the library.
+But please be aware that they might contain bugs or behaviour changes.
+
+### Proper release
+
+* Checkout `main`
+* Pull latest changes
+* Adjust version in [`build.gradle.kts`](build.gradle.kts) to a non-SNAPSHOT version
+* Commit
+* Create a git tag (e.g. `1.0.0`)
+* Push to `main` and push the `tag`
+* Increase the `version` to the next **minor** version in the `build.gradle.kts` file
+* Commit & Push
+
+> **Note**: The `tag` push will create a new release with the [`Publish` workflow](https://github.com/ioki-mobility/kmp-lokalise-api/actions/workflows/publish.yml).
+