feat: add the release tag into the container as env var and display i…

…n the AppInfo json response

Merge pull request #242 from DFE-Digital/Feature/update-app-info

.github/workflows/docker-publish.yml

@@ -14,6 +14,7 @@ env:
   REGISTRY: ghcr.io
   # github.repository as <account>/<repo>
   IMAGE_NAME: ${{ github.repository }}
+  RELEASE_TAG: ${{ github.event.release.tag_name }}
 
 jobs:
   build:
@@ -29,10 +30,10 @@ jobs:
 
     steps:
       # Checkout the release tag version
-      - name: Checkout repository ${{ github.event.release.tag_name }}
+      - name: Checkout repository ${{ env.RELEASE_TAG }}
         uses: actions/checkout@v3
         with:
-          ref: ${{ github.event.release.tag_name }}
+          ref: ${{ env.RELEASE_TAG }}
 
       # Get git commit hash
       - name: Get short hash
@@ -80,9 +81,9 @@ jobs:
         with:
           context: Childrens-Social-Care-CPD
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME_LOWER }}:${{ github.event.release.tag_name }},${{ env.REGISTRY }}/${{ env.IMAGE_NAME_LOWER }}:latest
+          tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME_LOWER }}:${{ env.RELEASE_TAG }},${{ env.REGISTRY }}/${{ env.IMAGE_NAME_LOWER }}:latest
           labels: ${{ steps.meta.outputs.labels }}
-          build-args: VCSREF=${{ env.sha_short }}
+          build-args: VCSREF=${{ env.sha_short }},VCSTAG=${{ env.RELEASE_TAG }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
 

Childrens-Social-Care-CPD-Tests/Controllers/AppInfoControllerTests.cs

@@ -61,4 +61,18 @@ public void AppInfo_Includes_Git_Hash()
         // assert
         actual.GitShortHash.Should().Be(value);
     }
+
+    [Test]
+    public void AppInfo_Includes_App_Version()
+    {
+        // arrange
+        var value = "foo";
+        _applicationConfiguration.AppVersion.Returns(value);
+
+        // act
+        var actual = _controller.AppInfo().Value as ApplicationInfo;
+
+        // assert
+        actual.Version.Should().Be(value);
+    }
 }

Childrens-Social-Care-CPD/ApplicationConfiguration.cs

@@ -4,6 +4,7 @@ public class ApplicationConfiguration : IApplicationConfiguration
 {
     private static string ValueOrStringEmpty(string key) => Environment.GetEnvironmentVariable(key) ?? string.Empty;
     public string AppInsightsConnectionString => ValueOrStringEmpty("CPD_INSTRUMENTATION_CONNECTIONSTRING");
+    public string AppVersion => ValueOrStringEmpty("VCS-TAG");
     public string AzureEnvironment => ValueOrStringEmpty("CPD_AZURE_ENVIRONMENT");
     public string ClarityProjectId => ValueOrStringEmpty("CPD_CLARITY");
     public string ContentfulDeliveryApiKey => ValueOrStringEmpty("CPD_DELIVERY_KEY");

Childrens-Social-Care-CPD/Controllers/AppInfoController.cs

@@ -1,29 +1,29 @@
 using Childrens_Social_Care_CPD.Models;
 using Microsoft.AspNetCore.Mvc;
 
-namespace Childrens_Social_Care_CPD.Controllers
+namespace Childrens_Social_Care_CPD.Controllers;
+
+public class AppInfoController : Controller
 {
-    public class AppInfoController : Controller
-    {
-        private readonly IApplicationConfiguration _applicationConfiguration;
+    private readonly IApplicationConfiguration _applicationConfiguration;
 
-        public AppInfoController(IApplicationConfiguration applicationConfiguration)
-        {
-            _applicationConfiguration = applicationConfiguration;
-        }
+    public AppInfoController(IApplicationConfiguration applicationConfiguration)
+    {
+        _applicationConfiguration = applicationConfiguration;
+    }
 
-        [HttpGet]
-        [Route("CPD/AppInfo")]
-        public JsonResult AppInfo()
+    [HttpGet]
+    [Route("CPD/AppInfo")]
+    public JsonResult AppInfo()
+    {
+        var applicationInfo = new ApplicationInfo()
         {
-            var applicationInfo = new ApplicationInfo()
-            {
-                Environment = _applicationConfiguration.AzureEnvironment,
-                ContentfulEnvironment = _applicationConfiguration.ContentfulEnvironment,
-                GitShortHash = _applicationConfiguration.GitHash
-            };
+            Environment = _applicationConfiguration.AzureEnvironment,
+            ContentfulEnvironment = _applicationConfiguration.ContentfulEnvironment,
+            GitShortHash = _applicationConfiguration.GitHash,
+            Version = _applicationConfiguration.AppVersion,
+        };
 
-            return Json(applicationInfo);
-        }
+        return Json(applicationInfo);
     }
 }

Childrens-Social-Care-CPD/Dockerfile

@@ -21,4 +21,6 @@ WORKDIR /app
 COPY --from=publish /app/publish .
 ARG VCSREF=0
 ENV VCS-REF=$VCSREF
+ARG VCSTAG=0.0.0
+ENV VCS-TAG=$VCSTAG
 ENTRYPOINT ["dotnet", "Childrens-Social-Care-CPD.dll"]

Childrens-Social-Care-CPD/IApplicationConfiguration.cs

@@ -3,6 +3,7 @@
 public interface IApplicationConfiguration 
 { 
     string AppInsightsConnectionString { get; }
+    string AppVersion { get; }
     string AzureEnvironment { get; }
     string ClarityProjectId { get; }
     string ContentfulDeliveryApiKey { get; }

Childrens-Social-Care-CPD/Models/ApplicationInfo.cs

@@ -1,11 +1,9 @@
-using Newtonsoft.Json;
+namespace Childrens_Social_Care_CPD.Models;
 
-namespace Childrens_Social_Care_CPD.Models
+public class ApplicationInfo
 {
-    public class ApplicationInfo
-    {
-        public string Environment { get; set; }
-        public string ContentfulEnvironment { get; set; }
-        public string GitShortHash { get; set; }
-    }
+    public string ContentfulEnvironment { get; set; }
+    public string Environment { get; set; }
+    public string GitShortHash { get; set; }
+    public string Version { get; set; }
 }