document behavior of COMMIT variable for make deploy

Azure · Dec 20, 2024 · b5586be · b5586be
1 parent 3dfa2ab
commit b5586be
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/config/config.yaml b/config/config.yaml
@@ -235,10 +235,10 @@ clouds:
         imageTag: 9aca808
       # Frontend
       frontend:
-        imageTag: '' # if empty uses commit sha of repo
+        imageTag: '' # if empty will use the most recent tag
       # Backend
       backend:
-        imageTag: '' # if empty uses commit sha of repo
+        imageTag: '' # if empty will use the most recent tag
       # Shared SVC KV
       serviceKeyVault:
         name: 'aro-hcp-dev-svc-kv'

diff --git a/dev-infrastructure/docs/development-setup.md b/dev-infrastructure/docs/development-setup.md
@@ -287,6 +287,15 @@ The ARO-HCP resource provider consists of independent frontend and backend compo
   make backend.deploy
   ```
 
+This will deploy the most recent image tags of the frontend and backend components.
+
+Optionally, a commit hash can be provided to the `frontend.deploy` and `backend.deploy` targets to deploy a specific version of the components. This is useful for testing changes in the frontend or backend components.
+
+  ```bash
+  make frontend.deploy COMMIT=<short-sha>
+  make backend.deploy  COMMIT=<short-sha>
+  ```
+
 To validate, have a look at the `aro-hcp` namespace on the service cluster.
 
 ## Deploy Services to the management cluster