Add DCA and Schematic versions to footer of dashboard. (#564)

* WIP: Add DCA and Schematic versions to footer of dashboard.

* Get schematic version via api call

* Use schematic version from variable in global.R

* Add version as an env variable to docker container

* When building docker container, use the github ref as a build arg to note the version.

* Change version variable to DCA_VERSION

* Set DCA_VERSION env var to a variable in the global env

* Show DCA version from the env var

* Use GITHUB_REF_NAME env var to set version env var.

* specify github context for github_ref_name var

* Update github ref name to github.REF_NAME

* For clarity, set build arg to DCA_VERSION instead of TAG.

* Add DCA_VERSION env var to .Renviron so it is loaded as env var in shiny server.

* Make DCA_VERSION from docker build-arg an env var in the container. Then in dca_startup.sh, add the env var to Renviron

* Add error handling for schematic version api call

.github/workflows/docker_build.yml

@@ -14,6 +14,7 @@ on:
 env:
   REGISTRY: ghcr.io
   IMAGE_PATH: ghcr.io/${{ github.repository }}
+  DCA_VERSION: ${{ github.REF_NAME }}
 
 jobs:
   build-and-push-image:
@@ -50,3 +51,6 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            DCA_VERSION=${{ env.DCA_VERSION }}
+

Dockerfile

@@ -1,5 +1,9 @@
 FROM ghcr.io/afwillia/shiny-base:release-update-node
-LABEL maintainer="Anthony [email protected]"
+
+# add version tag as a build argument
+ARG DCA_VERSION
+
+ENV DCA_VERSION=$DCA_VERSION
 
 USER root
 RUN apt-get update

dca_startup.sh

@@ -3,6 +3,7 @@
 # Pass environment variable to Shiny
 echo "" >> .Renviron
 echo R_CONFIG_ACTIVE=$R_CONFIG_ACTIVE >> .Renviron
+echo DCA_VERSION=$DCA_VERSION >> .Renviron
 
 # Now run the base start-up script
 ./startup.sh

global.R

@@ -61,8 +61,18 @@ if (dca_schematic_api == "rest") {
   Sys.getenv("DCA_API_PORT"),
   sep = ":")
   )
+
+  # Get Schematic version
+  get_schematic_version <- try(httr::GET(file.path(api_uri, "v1/version")), silent=TRUE)
+  if (inherits(get_schematic_version, "try-error")) {
+    schematic_version <- ""
+  } else if (httr::http_error(get_schematic_version)) {
+    schematic_version <- ""
+  } else schematic_version <- httr::content(get_schematic_version)
 }
 
+dca_version <- Sys.getenv("DCA_VERSION")
+
 dca_synapse_api <- Sys.getenv("DCA_SYNAPSE_PROJECT_API")
 
 # update port if running app locally

ui.R

@@ -294,6 +294,9 @@ ui <- shinydashboardPlus::dashboardPage(
   ),
   # waiter loading screen
   dcWaiter("show", landing = TRUE)
+  ),
+  footer = dashboardFooter(
+    left = sprintf("DCA %s - Schematic %s", dca_version, schematic_version)
   )
 )