Merge pull request #3606 from nhsuk/add-version-number-footer

Display current version of Mavis in the footer. The version is extracted from the current git ref or branch name used for deployment.

Author: murugapl

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

@@ -7,6 +7,9 @@ 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 }}
@@ -65,8 +68,10 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: ${{ inputs.git-sha || github.sha }}
-      - name: Write build SHA
-        run: git rev-parse HEAD > public/sha
+      - name: Write build metadata
+        run: |
+          git rev-parse HEAD > public/sha
+          echo "${{ inputs.git_ref_to_deploy || github.ref_name }}" > public/ref
       - name: Build Docker image
         run: docker build -t "mavis:latest" .
       - name: Save Docker image

.gitignore

@@ -58,5 +58,6 @@ scratchpad
 # Artillery temporarily bundles TypeScript files in this directory
 tests/dist
 
-# This file is autogenerated by the deploy GitHub Action
+# These files are autogenerated by the deploy GitHub Action
 public/sha
+public/ref

app/helpers/application_helper.rb

@@ -32,4 +32,16 @@ def page_title(service_name)
 
     safe_join([title, service_name], " – ")
   end
+
+  def app_version
+    return APP_VERSION if defined?(APP_VERSION) && APP_VERSION.present?
+
+    if Rails.env.local?
+      version = `git rev-parse --abbrev-ref HEAD 2>/dev/null`.strip
+      return nil if version.blank? || version == "HEAD"
+      return version
+    end
+
+    nil
+  end
 end

app/views/layouts/application.html.erb

@@ -60,6 +60,11 @@
                   <%= link_to "#{t("service.guide.title")} (opens in a new tab)", @service_guide_url, classes: "nhsuk-footer__list-item-link", target: "_blank" %>
                 </li>
               <% end %>
+              <% if app_version %>
+                <li class="nhsuk-footer__list-item nhsuk-footer-default__list-item nhsuk-u-secondary-text-color">
+                  <%= app_version %>
+                </li>
+              <% end %>
             </ul>
             <p class="nhsuk-footer__copyright">&copy; NHS England</p>
           </div>

config/initializers/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+path = Rails.root.join("public/ref")
+
+version = File.read(path).strip if File.exist?(path)
+APP_VERSION = version.presence