From b9bce35fd78992f50ade120995a0fbdac0dbb31f Mon Sep 17 00:00:00 2001
From: Robbie Blaine <4052340+rblaine95@users.noreply.github.com>
Date: Fri, 7 Feb 2025 12:04:31 +0200
Subject: [PATCH] :memo: Update CICD `README.md` (#1315)
* Use mermaid to draw simple cicd flowchart
* Remove outdated information about very old and deprecated helm charts
---
.github/workflows/README.md | 41 +++++++++++--------------------------
1 file changed, 12 insertions(+), 29 deletions(-)
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
index a529ef87bb..cdd7c795b1 100644
--- a/.github/workflows/README.md
+++ b/.github/workflows/README.md
@@ -1,34 +1,17 @@
# CI/CD
-:warning: WIP
+The CI/CD pipeline is defined in the [cicd.yml](cicd.yml) file.
-When deploying with [Helm repository](https://github.com/didx-xyz/cloud_api_helm), symlink the `./shared` dir inside `./helm/Chart/assets/shared`:
-
-```sh
-git clone git@github.com:didx-xyz/cloud_api_helm.git helm/Chart
-mkdir helm/Chart/assets
-cd helm/Chart/assets
-ln -s ../../../shared .
+```mermaid
+---
+title: CI/CD Pipeline
+---
+flowchart LR
+ Format(Check code
formatting) ---> Build(Build/Push all
Docker Images)
+ Unit(Run Unit Tests) ---> Build(Build/Push all
Docker Images)
+ Build ---> Local(Deploy and Test local
ephemeral k8s)
+ Build ---> Deploy(Deploy and Test EKS)
```
-From the root of this repo:
-
-```sh
-PROJECTS=(
- ledger-nodes
- ledger-browser
- tails-server
- governance-ga-agent
- governance-trust-registry
- governance-multitenant-web
- governance-multitenant-agent
- governance-endorser
-)
-
-for PROJECT in "${PROJECTS[@]}"; do
- helm -n app upgrade --install --atomic --timeout=300s \
- $PROJECT \
- -f "./helm/Values/$PROJECT.yaml" \
- ./helm/Chart/.
-done
-```
+Refer to the [helm](../../helm) directory for the Helm charts and Helmfile
+configs to deploy acapy-cloud.