Assessment: Assessment Pipeline

.github/workflows/cd-dev.yml

@@ -0,0 +1,64 @@
+name: Deploy Kaapi Dev to EC2
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: AWS_ENV
+
+    permissions:
+      packages: write
+      contents: read
+      attestations: write
+      id-token: write
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v6
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v6
+        with:
+          role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Deploy via SSM
+        id: ssm
+        env:
+          BUILD_DIRECTORY: ${{ secrets.DEV_BUILD_DIRECTORY }}
+          APP_NAME: ${{ secrets.DEV_PM2_APP_NAME }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          INSTANCE_ID: ${{ secrets.EC2_STAGING_INSTANCE_ID }}
+          ROOT_USER: ${{ secrets.USER }}
+        run: |
+          REMOTE_CMD="export HOME=/home/$ROOT_USER && export NVM_DIR="/home/$ROOT_USER/.nvm" && [ -s "\$NVM_DIR/nvm.sh" ] && \. "\$NVM_DIR/nvm.sh" && git config --global --add safe.directory ${BUILD_DIRECTORY} && set -e && cd ${BUILD_DIRECTORY} && git pull origin dev && npm ci && npm run build && sudo -iu ${ROOT_USER} pm2 restart ${APP_NAME}"
+          CMD_ID=$(aws ssm send-command \
+            --instance-ids "$INSTANCE_ID" \
+            --document-name "AWS-RunShellScript" \
+            --parameters commands="[\"$REMOTE_CMD\"]" \
+            --region "$AWS_REGION" \
+            --query 'Command.CommandId' \
+            --output text)
+          echo "cmd_id=$CMD_ID" >> "$GITHUB_OUTPUT"
+
+      - name: Wait for SSM command to finish
+        env:
+          INSTANCE_ID: ${{ secrets.EC2_STAGING_INSTANCE_ID }}
+          CMD_ID: ${{ steps.ssm.outputs.cmd_id }}
+        run: |
+          WAIT_EXIT=0
+          aws ssm wait command-executed \
+            --command-id "$CMD_ID" \
+            --instance-id "$INSTANCE_ID" || WAIT_EXIT=$?
+
+          aws ssm get-command-invocation \
+            --command-id "$CMD_ID" \
+            --instance-id "$INSTANCE_ID" \
+            --query '{Status:Status,Stdout:StandardOutputContent,Stderr:StandardErrorContent}' \
+            --output json
+
+          exit $WAIT_EXIT

README.md

@@ -14,6 +14,7 @@ This is a thin frontend UI for [Kaapi backend](https://github.com/ProjectTech4De
   - [Software Dependencies](#software-dependencies)
     - [npm (via asdf)](#npm-via-asdf)
   - [Kaapi Backend](#kaapi-backend)
+  - [Kaapi Guardrails Service](#kaapi-guardrails-service)
 - [Clone Frontend Repo](#clone-frontend-repo)
   - [Git commands to clone](#git-commands-to-clone)
 - [Installation](#installation)
@@ -52,11 +53,11 @@ You need to set up the [Kaapi backend](https://github.com/ProjectTech4DevAI/kaap
 
 > 💡 Note: Ensure the backend is running and accessible before starting the frontend.
 
-### Kaapi Guardrails Service _(coming soon)_
+### Kaapi Guardrails Service
 
-The Guardrails UI (currently in development) will require the Kaapi Guardrails service to be running alongside the backend. Setup instructions will be added here once the service is available.
+You need to set up the [Kaapi Guardrails](https://github.com/ProjectTech4DevAI/kaapi-guardrails) service and follow the instructions there.
 
-> 🚧 No action needed for now — this is a placeholder for when the Guardrails feature lands in `main`.
+> 💡 Note: The Guardrails service must be running and accessible whenever you use the Guardrails module in the frontend.
 
 ---
 
@@ -149,14 +150,14 @@ Deployments are automated via a GitHub Actions CD pipeline that SSHes into the E
 1. SSHes into the EC2 instance
 2. Runs `git pull` to fetch the latest code
 3. Runs `npm run build` to create an optimized production build
-4. Restarts the server to apply the new build
+4. Restarts the pm2 server to apply the new build
 
 **Production** — on every version tag (e.g. `v1.0.0`, `v2.1.0`), the pipeline automatically:
 
 1. SSHes into the EC2 instance
 2. Runs `git fetch --tags` and checks out the tag
 3. Runs `npm run build` to create an optimized production build
-4. Restarts the server to apply the new build
+4. Restarts the pm2 server to apply the new build
 
 ---
 
@@ -169,4 +170,4 @@ Deployments are automated via a GitHub Actions CD pipeline that SSHes into the E
 
 ### Chat With Us
 
-- 💬 [Discord](https://discord.gg/BRYzSYha)
+- 💬 [Discord](https://discord.gg/s7e2UBFku)