GitHub Version Tag to set Version within Rosalution and Changelog (#133)

* Updating Rosalution to use the build tag in the title

* Forgot to restore the original chagnes to the regular local deployment.

* Created a changelog to be used going forward for features and bug fixes

* Made the commenting out consistent

CHANGELOG.md

@@ -0,0 +1,24 @@
+<!-- markdownlint-disable-file MD024 -->
+# Changelog
+
+## 0.7.0 - latest
+
+### Features
+
+### Bug Fixes
+
+## 0.6.0
+
+### Features
+
+- Importing cases for analysis, with support of automated configured annotations of genomic units with support at
+  curating evidence for analysis review.
+- Attachment of supporting evidence as files or URLs
+- Support for researchers entering case relevant information to be disseminated to research team
+- Multi image attachment for curated figures for analyses
+- Attachment of visual annotations associated with genomic units
+- Viewing annotations for the genomic units in a case for analysis
+- CAS user login, enabling organizations to connect to their Center Authentication Service for user credentials
+- Filtering available analyses by data presented on analysis cards in the analysis feed
+- Workflows to change analyses from being in preparation to ready, active, approved, declined, on-hold
+- 3rd party attachments to link Monday.com and Phenotips to the specific analysis

README.md

@@ -298,6 +298,38 @@ registry.
 For additional information on the `build.sh` script, refer to the [build.sh script documentation](./build.sh) within the
  script itself.
 
+The local production docker compose yaml must be updated if you would like to test the docker images created from the
+`build.sh` script.  Modify the `docker-compose.local-production.yml` by:
+
+- Commenting out the build configuration designated within the compose yaml.
+
+```yaml
+  #build:
+    #context: ./frontend/
+    #target: production-stage
+    #dockerfile: Dockerfile
+    #args:
+      #VERSION_BUILD_TAG: "local-production@latest"
+```
+
+- Uncommenting the docker image tags for the `frontend` and `backend` services
+
+```yaml
+image: ghcr.io/uab-cgds-worthey/rosalution/frontend:${ROSALUTION_VERSION}
+```
+
+- Setting the ROSALUTION_VERSION environment variable to be the 'build tag' used with the `build.sh` script.
+
+```bash
+export ROSALUTION_VERSION=0.6.0
+```
+
+- Deploy the Rosalution Build as indicated in the following section
+
+```bash
+docker-compose -f docker-compose.local-production.yml up --build
+```
+
 #### Local deployment of a Production Build
 
 To deploy a production build locally, the following command can be uses.

build.sh

@@ -146,7 +146,7 @@ build(){
 
   # Making this a comment now to preserve code in the event we need the npmrc for future CGDS modules
   # docker_build_command="DOCKER_BUILDKIT=1 docker build --no-cache=true --secret id=npmrc,src=$npmrc_filepath --target=$build_target $(build_args "$service_name") --tag=$image_name -f ./$service_name/Dockerfile $build_context"
-  docker_build_command="DOCKER_BUILDKIT=1 docker build --no-cache=true --target=$build_target $(build_args "$service_name") --tag=$image_name -f ./$service_name/Dockerfile $build_context"
+  docker_build_command="DOCKER_BUILDKIT=1 docker build --no-cache=true --target=$build_target --build-arg=\"VERSION_BUILD_TAG=$build_tag\" $(build_args "$service_name") --tag=$image_name -f ./$service_name/Dockerfile $build_context"
 
   echo "Building $service_name..."
   eval "$docker_build_command"

docker-compose.local-production.yml

@@ -25,6 +25,9 @@ services:
       context: ./frontend/
       target: production-stage
       dockerfile: Dockerfile
+      args:
+        VERSION_BUILD_TAG: "local-production@latest"
+    # image: ghcr.io/uab-cgds-worthey/rosalution/frontend:${ROSALUTION_VERSION}
     networks:
       - rosalution-network
     labels:
@@ -43,6 +46,7 @@ services:
       context: ./backend/
       target: production-stage
       dockerfile: Dockerfile
+    # image: ghcr.io/uab-cgds-worthey/rosalution/backend:${ROSALUTION_VERSION}
     networks:
       - rosalution-network
     environment:
@@ -64,6 +68,7 @@ services:
       context: ./etc/fixtures/
       target: production-stage
       dockerfile: production.Dockerfile
+    # image: ghcr.io/uab-cgds-worthey/rosalution/database-fixture:${ROSALUTION_VERSION}
     networks:
       - rosalution-network
     environment:

docker-compose.yml

@@ -27,6 +27,8 @@ services:
       dockerfile: Dockerfile
     volumes:
       - ./frontend/src:/app/src
+    environment:
+      VITE_ROSALUTION_VERSION: "local@latest"
     networks:
       - rosalution-network
     labels:

frontend/Dockerfile

@@ -17,6 +17,9 @@ COPY package.json /app/
 COPY yarn.lock /app/
 COPY index.html /app/
 COPY vite.config.js /app/
+ARG VERSION_BUILD_TAG=latest
+
+ENV VITE_ROSALUTION_VERSION=$VERSION_BUILD_TAG
 
 RUN yarn install --frozen-lockfile && yarn build --base=/rosalution/
 

frontend/index.html

@@ -4,7 +4,7 @@
     <meta charset="utf-8" />
     <link rel="icon" href="/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>rosalution v0.1</title>
+    <title>rosalution %VITE_ROSALUTION_VERSION%</title>
   </head>
   <body>
     <div id="app"></div>

frontend/package.json

@@ -24,16 +24,16 @@
     "vue-router": "4.1.6"
   },
   "devDependencies": {
-    "@vitejs/plugin-vue": "4.0.0",
+    "@vitejs/plugin-vue": "4.3.4",
     "@vitest/coverage-c8": "0.27.2",
     "@vitest/ui": "0.27.2",
-    "@vue/test-utils": "2.2.7",
+    "@vue/test-utils": "2.4.1",
     "eslint": "8.32.0",
     "eslint-config-google": "0.14.0",
     "eslint-plugin-vue": "9.9.0",
     "happy-dom": "6.0.4",
     "sinon": "15.0.1",
-    "vite": "4.0.4",
+    "vite": "4.4.9",
     "vitest": "0.27.2"
   }
 }