Run prod deploy only on version release

Author: devksingh4

.github/workflows/deploy-prod.yml

@@ -2,10 +2,11 @@ name: Deploy all resources to PROD
 run-name: PROD deploy - @${{ github.actor }}
 
 on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
+  release:
+    types: [created]
+    tags:
+      - 'v*'
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -56,12 +57,17 @@ jobs:
           restore-keys: |
             yarn-modules-${{ runner.arch }}-${{ runner.os }}-
 
+      - name: Extract version from tag
+        id: get_version
+        run: echo "VITE_BUILD_HASH=${GITHUB_REF#refs/tags/v}" >> "$GITHUB_ENV"
+
       - name: Run build
         run: make build
         env:
           HUSKY: "0"
           VITE_RUN_ENVIRONMENT: prod
           RunEnvironment: prod
+          VITE_BUILD_HASH: ${{ env.VITE_BUILD_HASH }}
 
       - name: Upload Build files
         uses: actions/upload-artifact@v4

Makefile

@@ -61,7 +61,7 @@ build_swagger:
 
 build: src/ cloudformation/
 	yarn -D
-	VITE_BUILD_HASH=$(GIT_HASH) yarn build
+	yarn build
 	make build_swagger
 	cp -r src/api/resources/ dist/api/resources
 	rm -rf dist/lambda/sqs

README.md

@@ -7,4 +7,4 @@ This repository is split into multiple parts:
 ## Getting Started
 You will need node>=22 installed, as well as the AWS CLI and the AWS SAM CLI. The best way to work with all of this is to open the environment in a container within your IDE (VS Code should prompt you to do so: use "Clone in Container" for best performance). This container will have all needed software installed.
 
-Then, run `make install` to install all packages, and `make local` to start the UI and API servers! The UI will be accessible on `http://localhost:5173/` and the API on `http://localhost:8080/`.
+Then, run `make install` to install all packages, and `make local` to start the UI and API servers! The UI will be accessible on `http://localhost:5173/` and the API on `http://localhost:8080/`.

cspell.config.yaml

@@ -0,0 +1,11 @@
+version: "0.2"
+ignorePaths:
+  - cloudformation/**
+  - Makefile
+  - .github/**
+dictionaryDefinitions: []
+dictionaries: []
+words:
+  - UIUC
+ignoreWords: []
+import: []

src/api/createSwagger.ts

@@ -20,6 +20,11 @@ async function createSwaggerFiles() {
     await mkdir(outputDir, { recursive: true });
     const swaggerConfig = app.swagger();
     const realSwaggerConfig = JSON.parse(JSON.stringify(swaggerConfig));
+    // set version
+    if (process.env.VITE_BUILD_HASH) {
+      realSwaggerConfig.info = realSwaggerConfig.info || {};
+      realSwaggerConfig.info.version = process.env.VITE_BUILD_HASH;
+    }
     realSwaggerConfig.components = realSwaggerConfig.components || {};
     realSwaggerConfig.components.securitySchemes = securitySchemes;
     const jsonSpec = JSON.stringify(realSwaggerConfig, null, 2);