Add cache for clickhouse migrator (#937)

Author: jakubno

.github/actions/start-services/action.yml

@@ -44,6 +44,21 @@ runs:
         make -C tests/integration seed
       shell: bash
 
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Build codegen image with caching
+      uses: docker/build-push-action@v6
+      with:
+        context: packages/clickhouse
+        file: packages/clickhouse/Dockerfile
+        tags: clickhouse-migrator:latest
+        load: true # makes the image available for `docker run`
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+
+
     - name: Run Clickhouse
       env:
         CLICKHOUSE_USERNAME: "e2b"
@@ -62,7 +77,8 @@ runs:
         while [ "$(docker inspect -f '{{.State.Health.Status}}' clickhouse 2>/dev/null)" != "healthy" ]; do echo "Waiting for Clickhouse to be healthy..."; sleep 2; done
         echo "Clickhouse is healthy!"
 
-        make -C packages/clickhouse migrate
+        # We build the image in separate step to cache it and avoid rebuilding it every time
+        make -C packages/clickhouse migrate-without-build
       shell: bash
 
     - name: Start Services

.github/workflows/pull-request.yml

@@ -40,6 +40,9 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           path: artifacts
+          # Docker build artifacts have to ignored
+          # https://github.com/actions/toolkit/pull/1874
+          pattern: "!*.dockerbuild"
 
       - name: Publish Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2

packages/clickhouse/Dockerfile

@@ -5,14 +5,14 @@ RUN apk add --no-cache git
 RUN go install github.com/pressly/goose/v3/cmd/[email protected]
 
 # Final stage
-FROM alpine:latest
+FROM alpine:3.22.1
 
 RUN apk add --no-cache bash ca-certificates
 
 COPY --from=builder /go/bin/goose /usr/local/bin/goose
 
 WORKDIR /app
-COPY /migrations ./migrations
+COPY migrations/ ./migrations/
 
 ENV GOOSE_DRIVER=clickhouse
 ENTRYPOINT ["goose", "-table", "_migrations", "-dir", "migrations", "up"]

packages/clickhouse/Makefile

@@ -5,7 +5,10 @@ CLICKHOUSE_MIGRATOR_IMAGE ?= $(GCP_REGION)-docker.pkg.dev/$(GCP_PROJECT_ID)/e2b-
 CLICKHOUSE_HOST ?= clickhouse
 
 .PHONY: migrate
-migrate:build
+migrate: build migrate-without-build
+
+.PHONY: migrate-without-build
+migrate-without-build:
 	@echo "Applying Clickhouse migrations *$(notdir $@)*"
 	@docker network create e2b || true
 	@docker run --rm \
@@ -18,7 +21,6 @@ migrate:build
 
 .PHONY: build
 build:
-	@echo "$(CLICKHOUSE_MIGRATOR_IMAGE)"
 	@docker build --platform linux/amd64 --tag "$(CLICKHOUSE_MIGRATOR_IMAGE)" .
 
 .PHONY: build-and-upload