Merge pull request #3661 from nhsuk/fix-version-number-footer

Fix version number display in production

Author: murugapl

.github/workflows/build-and-push-image.yml

@@ -7,9 +7,6 @@ on:
       git-sha:
         description: The git commit sha to build the image from.
         type: string
-      git_ref_to_deploy:
-        required: false
-        type: string
 
 concurrency:
   group: build-and-push-image-${{ inputs.git-sha || github.sha }}
@@ -68,10 +65,8 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: ${{ inputs.git-sha || github.sha }}
-      - name: Write build metadata
-        run: |
-          git rev-parse HEAD > public/sha
-          echo "${{ inputs.git_ref_to_deploy || github.ref_name }}" > public/ref
+      - name: Write build SHA
+        run: git rev-parse HEAD > public/sha
       - name: Build Docker image
         run: docker build -t "mavis:latest" .
       - name: Save Docker image

.github/workflows/deploy-infrastructure.yml

@@ -20,6 +20,10 @@ on:
         description: Docker image tag to deploy
         required: false
         type: string
+      git_ref_to_deploy:
+        required: true
+        type: string
+
   workflow_call:
     inputs:
       environment:
@@ -29,6 +33,9 @@ on:
       image_tag:
         required: false
         type: string
+      git_ref_to_deploy:
+        required: true
+        type: string
 
 permissions: {}
 
@@ -141,12 +148,15 @@ jobs:
         run: sudo snap install --classic aws-cli
       - name: Check if any deployments are running
         run: ../scripts/check-for-running-deployments.sh ${{ inputs.environment }}
+      - name: Set Mavis app version
+        run: |
+          echo "APP_VERSION=${{ inputs.git_ref_to_deploy }}" >> $GITHUB_ENV
       - name: Terraform Plan
         id: plan
         run: |
           set -e
           terraform init -backend-config="env/${{ inputs.environment }}-backend.hcl" -upgrade
-          terraform plan -var="image_digest=$DIGEST" -var-file="env/${{ inputs.environment }}.tfvars" \
+          terraform plan -var="image_digest=$DIGEST" -var="app_version=$APP_VERSION" -var-file="env/${{ inputs.environment }}.tfvars" \
           -out ${{ runner.temp }}/tfplan | tee ${{ runner.temp }}/tf_stdout
       - name: Validate the changes
         run: |

.github/workflows/deploy.yml

@@ -85,6 +85,7 @@ jobs:
     with:
       environment: ${{ inputs.environment }}
       image_tag: ${{ needs.determine-git-sha.outputs.git-sha }}
+      git_ref_to_deploy: ${{ inputs.git_ref_to_deploy || github.ref_name }}
   deploy-application:
     permissions:
       id-token: write

config/initializers/version.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-path = Rails.root.join("public/ref")
+version = ENV["APP_VERSION"]
+if Rails.env.production? && version.present? &&
+     !version.match?(/\Av\d+(\.\d+)+\z/)
+  version = nil
+end
 
-version = File.read(path).strip if File.exist?(path)
 APP_VERSION = version.presence

terraform/app/variables.tf

@@ -157,6 +157,12 @@ variable "enable_splunk" {
   nullable    = false
 }
 
+variable "app_version" {
+  type        = string
+  description = "The version identifier for the MAVIS application deployment"
+  nullable    = false
+}
+
 locals {
   is_production = var.environment == "production"
   parameter_store_variables = tomap({
@@ -202,6 +208,10 @@ locals {
     {
       name  = "MAVIS__SPLUNK__ENABLED"
       value = var.enable_splunk ? "true" : "false"
+    },
+    {
+      name  = "APP_VERSION"
+      value = var.app_version
     }
   ]
   task_secrets = concat([