search

nwsde / nwsde-azuretre

An accelerator to help organizations build Trusted Research Environments on Azure.
https://microsoft.github.io/AzureTRE
MIT License
0 stars 0 forks source link

UI customisations: Customisable product name & footer text #6

Open jonnyry opened 7 months ago

jonnyry commented 7 months ago

Allow the following to be customisable via the use of environment/deployment variables:

Nb. these have already been customised in issue nwsde/AzureTRE#2, however this ticket extends the ability to customise them via variables.

asasaas

vvcb commented 7 months ago

It will also be great to have a deployment time and commit hash and/or version tag in the footer.

And conditional CSS so that the Dev, test and prod deployments are visually different.

jonnyry commented 7 months ago

Proposed solution:

Variables

Var name Description Example Mandatory Default if not set Where set/generated Fixed in issue
UI_PRODUCT_NAME TRE product name shown in UI Azure TRE no (not shown) config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
UI_FOOTER_TEXT Footer text in bottom status panel of UI Azure Trusted Research Environment no (not shown) config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
UI_ENV_NAME Text to shown on environment label in UI DEV, STAGE, TEST no Azure TRE config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
UI_ENV_LABEL_COLOUR Background colour of label #555555 no Azure Trusted Research Environment config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
DEPLOY_TIME (Last) deployment time 2023-11-27 T13:24:30 no (not shown) Generated in GitHub Action / Makefile on deploy nwsde/AzureTRE#5
GITHUB_REF GitHub REF - i.e. branch name OR tag develop, v0.15.2 no (not shown) Generated in GitHub Action / Makefile on deploy nwsde/AzureTRE#5
GITHUB_HASH Commit hash 1e4683f no (not shown) Generated in GitHub Action / Makefile on deploy nwsde/AzureTRE#5

Placement in the UI

Capture

jonnyry commented 7 months ago

@vvcb could you review the above before I implement the changes?

vvcb commented 7 months ago

@jonnyry , this looks comprehensive. 🚀 Happy for this to be implemented.

jonnyry commented 7 months ago

Splitting into three issues due to complexities around Git ref/hash & potential for merging back upstream: