From 3cad6f726c82e47270c4e5d98620b55285e93d7d Mon Sep 17 00:00:00 2001
From: Kalin Daskalov <kalin.daskalov@vereign.com>
Date: Tue, 7 Nov 2023 11:25:01 +0200
Subject: [PATCH] edit readme to include deploy guide

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c5eb3ad..387565b 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,18 @@
 
 ![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: v1.0.1-rc](https://img.shields.io/badge/AppVersion-v1.0.1--rc-informational?style=flat-square)
 
-cache deployment
+## Deployment
+
+The pipeline in this repo builds image from the source code repo in eclipse as a submodule in `app/`. It also packages and pushes the helm chart and triggers manual deployment to `dev-ssi` or `prod-ssi(vault)`
+
+### From main branch
+
+When changes to helm or the app are made and deployment is needed, execute the following steps:
+1. Clone the repo and start working on a new branch.
+2. Execute `git submode update --remote --recursive -init` to update source to latest commit on eclipse main branch.
+1. Edit `Chart.yaml` with the new chart version (example: 1.4.3) and app version it's intended to use (example: v1.4.3).
+2. Create a new tag with the intended app version (v1.4.3)
+3. Wait for pipelines to finish and manually trigger deployment to either `dev-ssi` or `prod-ssi(vault)` clusters.
 
 ## Values
 
-- 
GitLab