Add GitHub Action for building and pushing UI and BFF images

Signed-off-by: Griffin-Sullivan <[email protected]>

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

@@ -13,6 +13,7 @@ on:
       - '.github/ISSUE_TEMPLATE/**'
       - '.github/dependabot.yml'
       - 'docs/**'
+      - 'clients/ui/**'
 env:
   IMG_ORG: kubeflow
   IMG_REPO: model-registry

.github/workflows/build-and-push-ui-images.yml

@@ -0,0 +1,94 @@
+name: Build and Push UI and BFF Images
+on:
+  pull_request:
+    branches:
+      - 'main'
+    tags:
+      - 'v*'
+    paths:
+      - 'clients/ui/**'
+env:
+  IMG_ORG: kubeflow
+  IMG_UI_REPO: model-registry-ui
+  IMG_BFF_REPO: model-registry-bff
+  DOCKER_USER: ${{ secrets.DOCKERHUB_USERNAME }}
+  DOCKER_PWD: ${{ secrets.DOCKERHUB_TOKEN }}
+  PUSH_IMAGE: true
+jobs:
+  build-image:
+    runs-on: ubuntu-latest
+    steps:
+      # Assign context variable for various action contexts (tag, main, CI)
+      - name: Assigning tag context
+        if: github.head_ref == '' && startsWith(github.ref, 'refs/tags/v')
+        run: echo "BUILD_CONTEXT=tag" >> $GITHUB_ENV
+      - name: Assigning main context
+        if: github.head_ref == '' && github.ref == 'refs/heads/main'
+        run: echo "BUILD_CONTEXT=main" >> $GITHUB_ENV
+      # checkout branch
+      - uses: actions/checkout@v4
+      # set image version
+      - name: Set main-branch environment
+        if: env.BUILD_CONTEXT == 'main'
+        run: |
+          commit_sha=${{ github.event.after }}
+          tag=main-${commit_sha:0:7}
+          echo "VERSION=${tag}" >> $GITHUB_ENV
+      - name: Set tag environment
+        if: env.BUILD_CONTEXT == 'tag'
+        run: |
+          echo "VERSION=${{ github.ref_name }}" >> $GITHUB_ENV
+      - name: Build and Push UI Image
+        shell: bash
+        env:
+          IMG_REPO: ${{ env.IMG_UI_REPO }}
+        run: ./scripts/build_deploy.sh
+      - name: Build and Push BFF Image
+        shell: bash
+        env:
+          IMG_REPO: ${{ env.IMG_BFF_REPO }}
+        run: ./scripts/build_deploy.sh
+      - name: Tag Latest UI Image
+        if: env.BUILD_CONTEXT == 'main'
+        shell: bash
+        env:
+          IMG_REPO: ${{ env.IMG_UI_REPO }}
+          IMG: ${{ env.IMG_ORG }}/${{ env.IMG_UI_REPO }}
+          BUILD_IMAGE: false # image is already built in "Build and Push UI Image" step
+        run: |
+          docker tag ${{ env.IMG }}:$VERSION ${{ env.IMG }}:latest
+          # BUILD_IMAGE=false skip the build, just push the tag made above
+          VERSION=latest ./scripts/build_deploy.sh
+      - name: Tag Latest BFF Image
+        if: env.BUILD_CONTEXT == 'main'
+        shell: bash
+        env:
+          IMG_REPO: ${{ env.IMG_BFF_REPO }}
+          IMG: ${{ env.IMG_ORG }}/${{ env.IMG_BFF_REPO }}
+          BUILD_IMAGE: false # image is already built in "Build and Push BFF Image" step
+        run: |
+          docker tag ${{ env.IMG }}:$VERSION ${{ env.IMG }}:latest
+          # BUILD_IMAGE=false skip the build, just push the tag made above
+          VERSION=latest ./scripts/build_deploy.sh
+      - name: Tag Main UI Image
+        if: env.BUILD_CONTEXT == 'main'
+        shell: bash
+        env:
+          IMG_REPO: ${{ env.IMG_UI_REPO }}
+          IMG: ${{ env.IMG_ORG }}/${{ env.IMG_UI_REPO }}
+          BUILD_IMAGE: false # image is already built in "Build and Push UI Image" step
+        run: |
+          docker tag ${{ env.IMG }}:$VERSION ${{ env.IMG }}:main
+          # BUILD_IMAGE=false skip the build, just push the tag made above
+          VERSION=main ./scripts/build_deploy.sh
+      - name: Tag Main BFF Image
+        if: env.BUILD_CONTEXT == 'main'
+        shell: bash
+        env:
+          IMG_REPO: ${{ env.IMG_BFF_REPO }}
+          IMG: ${{ env.IMG_ORG }}/${{ env.IMG_BFF_REPO }}
+          BUILD_IMAGE: false # image is already built in "Build and Push BFF Image" step
+        run: |
+          docker tag ${{ env.IMG }}:$VERSION ${{ env.IMG }}:main
+          # BUILD_IMAGE=false skip the build, just push the tag made above
+          VERSION=main ./scripts/build_deploy.sh

.github/workflows/build-image-pr.yml

@@ -10,6 +10,7 @@ on:
       - ".github/dependabot.yml"
       - "docs/**"
       - "clients/python/docs/**"
+      - 'clients/ui/**'
 env:
   IMG_ORG: kubeflow
   IMG_REPO: model-registry

Makefile

@@ -3,6 +3,8 @@ MKFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
 PROJECT_PATH := $(patsubst %/,%,$(dir $(MKFILE_PATH)))
 PROJECT_BIN := $(PROJECT_PATH)/bin
 GO ?= "$(shell which go)"
+BFF_PATH := $(PROJECT_PATH)/clients/ui/bff
+UI_PATH := $(PROJECT_PATH)/clients/ui/frontend
 
 # add tools bin directory
 PATH := $(PROJECT_BIN):$(PATH)
@@ -28,6 +30,15 @@ else
     IMG := ${IMG_ORG}/${IMG_REPO}
 endif
 
+# Change Dockerfile path depending on IMG_REPO
+ifeq ($(IMG_REPO),model-registry-ui)
+    DOCKERFILE := $(UI_PATH)/Dockerfile
+endif
+
+ifeq ($(IMG_REPO),model-registry-bff)
+    DOCKERFILE := $(BFF_PATH)/Dockerfile
+endif
+
 model-registry: build
 
 # clean the ml-metadata protos and trigger a fresh new build which downloads

clients/ui/bff/README.md

@@ -19,7 +19,7 @@ docker compose -f docker-compose[-local].yaml up
 
 The main difference between the two docker compose files is that `-local` one builds the model registry from source, the other one, instead, download the `latest` pushed [quay.io](https://quay.io/repository/opendatahub/model-registry?tab=tags) image.
 
-When shutting down the docker compose, you might want to clean-up the SQLite db file generated by ML Metadata, for example `./test/config/ml-metadata/metadata.sqlite.db`
+When shutting down the docker compose, you might want to clean-up the SQLite db file generated by ML Metadata, for example `./test/config/ml-metadata/metadata.sqlite.db`.
 
 # Development