Project Deployment

🧾 Overview

This document outlines the Git tag–based deployment process for the project, which consists of a frontend-only application.

Deployments are triggered via Git tags pushed using GitKraken, with different tag formats for each environment and platform:

• Vercel – Environments: feature, develop, staging
• Google Cloud Platform (GCP) – Environments: feature, develop, staging, pre-prod, prod

🧰 Tools Used

• GitKraken – Git client used to push tags
• Vercel – Hosts frontend for testing environments
• GCP – Hosts frontend in staging, pre-prod, and production
• CI/CD Pipelines:
  • bundle_size_and_deploy to check bundle size on feature tag creation
  • benchmarks_and_automated_tests triggered after production release to run performance and automated tests

🚀 Deployment Strategy

Deployment is fully automated and triggered by pushing Git tags. Each environment listens for tags that follow a specific format.

📌 Tagging Conventions

✅ Vercel Tags

• Format:
  • feature_devops, dev-X.Y.Z, staging-X.Y.Z
  • Release Candidate Format for Staging: staging-X.Y.Z-rcX
• CI/CD Pipeline – bundle_size_and_deploy to check bundle size on feature tag creation

☁️ GCP Tags

• Format:
  • feature-X.Y.Z, dev-X.Y.Z, staging-X.Y.Z
  • For Pre-Prod and Prod: just X.Y.Z
  • Release Candidate Format for Staging: staging-X.Y.Z-rcX

Tag Usage:

⚠️ No separate prod- tag is required. The client promotes the same version deployed to Pre-Prod.

🏷️ Tagging Workflow in GitKraken

1. Right-click on the commit to deploy.
2. Click Create Tag.
3. Enter the tag name using the appropriate format.
4. Click Push Tag to Origin.

Example: Pre-Prod → Prod

# Step 1: Create and push tag to deploy to Pre-Prod
Tag: 1.1.1

# Step 2: Client reviews and approves in Pre-Prod

# Step 3: Client promotes same tag to Prod (manually)

Key Updates to the benchmarks_and_automated_tests Pipeline:

1. Tag Format: The tag prod-devops/x.x.x-test-1 is created after production deployment.
2. Purpose: This pipeline runs benchmark and automated tests on the production deployment to ensure performance and correctness.
3. Trigger Action: The pipeline is triggered by pushing the prod-devops/x.x.x-test-1 tag, which initiates the test suite.

🔍 Build Monitoring Links

You can check the build status and logs directly from the deployment platforms:

🔧 Vercel Build Dashboard

• Vercel Project Dashboard

☁️ GCP Cloud Build Logs

• GCP Cloud Build History

You may need appropriate permissions to access the above dashboards.

⚠️ Important Notes

• ✅ Use Semantic Versioning: Tag using the MAJOR.MINOR.PATCH format (e.g., 1.2.3)
• 🛑 Do not overwrite tags: Each tag should represent a unique, stable release
• 🔁 Prod uses the same tag as Pre-Prod: No new tag is needed for Prod; the client promotes the exact same version deployed to Pre-Prod (e.g., 1.1.1)
• 👀 Client Approval Required: Only after approval in Pre-Prod can the version be promoted to Production
• 🧪 Test before tagging: Ensure the version is stable and verified in staging