From 40f6776c46abc4b9c89fb2aa195f4ce64b312cf6 Mon Sep 17 00:00:00 2001
From: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com>
Date: Mon, 20 May 2024 18:31:35 +0530
Subject: [PATCH] docs: update Docker Compose setup guide to checkout `latest`
 tag (#4695)

---
 .github/workflows/release-stable-version.yml | 14 +++++++++++++-
 README.md                                    |  4 +++-
 docs/try_local_system.md                     | 10 +++++-----
 3 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/release-stable-version.yml b/.github/workflows/release-stable-version.yml
index 64609aed86..54a4d2b1a4 100644
--- a/.github/workflows/release-stable-version.yml
+++ b/.github/workflows/release-stable-version.yml
@@ -118,7 +118,7 @@ jobs:
           echo "PREVIOUS_TAG=${PREVIOUS_TAG}" >> $GITHUB_ENV
           echo "NEXT_TAG=${NEXT_TAG}" >> $GITHUB_ENV
 
-        # We make use of GitHub API calls to create the tag to have signed tags
+        # We make use of GitHub API calls to create and update tags
       - name: Create SemVer tag
         shell: bash
         env:
@@ -133,6 +133,18 @@ jobs:
             --raw-field "ref=refs/tags/${NEXT_TAG}" \
             --raw-field 'sha=${{ github.sha }}'
 
+      - name: Update `latest` tag to point to newly created SemVer tag
+        shell: bash
+        env:
+          GH_TOKEN: ${{ steps.generate_app_token.outputs.token }}
+        run: |
+          gh api \
+            --method PATCH \
+            --header 'Accept: application/vnd.github+json' \
+            --header 'X-GitHub-Api-Version: 2022-11-28' \
+            '/repos/{owner}/{repo}/git/refs/tags/latest' \
+            --raw-field 'sha=${{ github.sha }}'
+
       - name: Generate changelog
         shell: bash
         run: |
diff --git a/README.md b/README.md
index 2be649b1db..5bfcfdfd62 100644
--- a/README.md
+++ b/README.md
@@ -75,10 +75,12 @@ The fastest and easiest way to try Hyperswitch is via our CDK scripts
 You can run Hyperswitch on your system using Docker Compose after cloning this repository:
 
 ```shell
+git clone --depth 1 --branch latest https://github.com/juspay/hyperswitch
+cd hyperswitch
 docker compose up -d
 ```
 
-This will start the payments router, the primary component within Hyperswitch.
+This will start the app server, web client and control center.
 
 Check out the [local setup guide][local-setup-guide] for a more comprehensive
 setup, which includes the [scheduler and monitoring services][docker-compose-scheduler-monitoring].
diff --git a/docs/try_local_system.md b/docs/try_local_system.md
index a13d04ade8..a05e9b9f44 100644
--- a/docs/try_local_system.md
+++ b/docs/try_local_system.md
@@ -36,7 +36,7 @@ Check the Table Of Contents to jump to the relevant section.
 2. Clone the repository and switch to the project directory:
 
    ```shell
-   git clone https://github.com/juspay/hyperswitch
+   git clone --depth 1 --branch latest https://github.com/juspay/hyperswitch
    cd hyperswitch
    ```
 
@@ -51,13 +51,13 @@ Check the Table Of Contents to jump to the relevant section.
    docker compose up -d
    ```
 
-   This should run the hyperswitch payments router, the primary component within
-   hyperswitch.
+   This should run the hyperswitch app server, web client and control center.
    Wait for the `migration_runner` container to finish installing `diesel_cli`
-   and running migrations (approximately 2 minutes) before proceeding further.
+   and running migrations (approximately 2 minutes), and for the
+   `hyperswitch-web` container to finish compiling before proceeding further.
    You can also choose to
    [run the scheduler and monitoring services](#run-the-scheduler-and-monitoring-services)
-   in addition to the payments router.
+   in addition to the app server, web client and control center.
 
 5. Verify that the server is up and running by hitting the health endpoint: