From f9414579e0b4bd01d3810ad53ad0982b98b1fbe6 Mon Sep 17 00:00:00 2001
From: theboringstuff <39027092+theboringstuff@users.noreply.github.com>
Date: Thu, 7 Nov 2024 16:20:29 +0300
Subject: [PATCH] add release doc

---
 documentation/internal/Release.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 documentation/internal/Release.md

diff --git a/documentation/internal/Release.md b/documentation/internal/Release.md
new file mode 100644
index 000000000..96de7c8de
--- /dev/null
+++ b/documentation/internal/Release.md
@@ -0,0 +1,15 @@
+# Releasing KubeMarine
+
+If you want to make a new KubeMarine release, you need to do following:
+1. Update KubeMarine version and create tag (replace `X.X.X` with actual version):
+    ```
+    python3 -m pip install bumpver
+    python3 -m bumpver update --set-version=X.X.X
+    ```
+2. Wait for GitHub Actions completion and verify released artifacts. Following artifacts are essential for each tag:
+    * KubeMarine binaries for different OS. They could be found in release assets.
+    * KubeMarine python distribution package. They could be found in release assets.
+    * [KubeMarine image](https://github.com/Netcracker/KubeMarine/pkgs/container/kubemarine).
+    * [Kubemarine documentation](https://github.com/Netcracker/KubeMarine/tree/main/documentation).
+
+3. Once you have verified that KubeMarine artifacts are OK, change your release from `pre-release` to `latest release` on [GitHub Release page](https://github.com/Netcracker/KubeMarine/releases). This will publish KubeMarine distribution package to PyPI.