From 22d4896b4b31cdef54bc62aeafae6961b6905343 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=BDiga=20Kokelj?= <ziga.kokelj@gmail.com>
Date: Mon, 2 Sep 2024 11:39:04 +0200
Subject: [PATCH] explain which env variables are needed in a github action

---
 .github/workflows/manual-deploy-obscuro-gateway.yml  | 12 ++++++++++++
 .../workflows/manual-deploy-ten-gateway-frontend.yml |  9 +++++++++
 2 files changed, 21 insertions(+)

diff --git a/.github/workflows/manual-deploy-obscuro-gateway.yml b/.github/workflows/manual-deploy-obscuro-gateway.yml
index 3a29807a72..6af9a95608 100644
--- a/.github/workflows/manual-deploy-obscuro-gateway.yml
+++ b/.github/workflows/manual-deploy-obscuro-gateway.yml
@@ -1,6 +1,18 @@
 # Deploys Ten Gateway on Azure for Testnet
 # Builds the Ten Gateway image, pushes the image to dockerhub and starts the Ten Gateway on Azure VM
 
+# This action requires the following environment variables to be set:
+#  - DOCKER_BUILD_TAG_GATEWAY
+#  - AZURE_DEPLOY_GROUP_GATEWAY
+#  - L2_RPC_URL_VALIDATOR
+#  - GATEWAY_RATE_LIMIT_USER_COMPUTE_TIME
+#  - GATEWAY_RATE_LIMIT_WINDOW
+#  - GATEWAY_MAX_CONCURRENT_REQUESTS_PER_USER
+
+# If we are deploying to a non primary instance all those variables should be prefixed with the instance name
+# example: dexynth-DOCKER_BUILD_TAG_GATEWAY
+
+
 name: '[M] Deploy Ten Gateway Backend'
 run-name: '[M] Deploy Ten Gateway Backend ( ${{ github.event.inputs.testnet_type }} )'
 on:
diff --git a/.github/workflows/manual-deploy-ten-gateway-frontend.yml b/.github/workflows/manual-deploy-ten-gateway-frontend.yml
index ecda602e4a..9d9cc3d7af 100644
--- a/.github/workflows/manual-deploy-ten-gateway-frontend.yml
+++ b/.github/workflows/manual-deploy-ten-gateway-frontend.yml
@@ -1,6 +1,15 @@
 # Deploys Ten Gateway Frontend on Azure for Testnet
 # Builds the Ten Gateway image, pushes the image to dockerhub and starts the Ten Gateway on Azure VM
 
+# This action requires the following environment variables to be set:
+# - DOCKER_BUILD_TAG_GATEWAY_FE
+# - GATEWAY_URL
+# - NETWORK_NAME
+# - TENSCAN_URL
+
+# If we are deploying to a non primary instance all those variables should be prefixed with the instance name
+# example: dexynth-GATEWAY_URL
+
 name: '[M] Deploy Ten Gateway Frontend'
 run-name: '[M] Deploy Ten Gateway Frontend ( ${{ github.event.inputs.testnet_type }} )'
 on: