Automatically set image versions when releasing (#303)

* override versions

* Fix path to vars in ldflags

* Add default tags to Makefile + fix image name in kustomize step

* Set up the docker build to inject the container versions to use

* Fix build workflow to verify fetched image tags and improve error handling

* Just use the docker build workflow to test docker builds, rather than a separate step in test

Author: cmmarslender

.github/workflows/build.yml

@@ -6,6 +6,7 @@ on:
       - main
     tags:
       - '**'
+  pull_request:
   workflow_dispatch:
   schedule:
     - cron: '0 0 * * 0'
@@ -17,4 +18,41 @@ permissions:
 
 jobs:
   package:
-    uses: Chia-Network/actions/.github/workflows/docker-build.yaml@main
+    runs-on: ubuntu-latest
+    timeout-minutes: 360
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set Env
+        uses: Chia-Network/actions/setjobenv@main
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set dependency versions
+        run: |
+          set -e
+          CHIA_IMAGE_TAG=$(curl -fsSL https://latest.cmm.io/chia)
+          EXPORTER_IMAGE_TAG=$(curl -fsSL https://latest.cmm.io/chia-exporter)
+          HEALTHCHECK_IMAGE_TAG=$(curl -fsSL https://latest.cmm.io/chia-healthcheck)
+
+          # Verify all variables are set
+          if [ -z "$CHIA_IMAGE_TAG" ] || [ -z "$EXPORTER_IMAGE_TAG" ] || [ -z "$HEALTHCHECK_IMAGE_TAG" ]; then
+            echo "Error: Failed to fetch one or more version tags"
+            echo "CHIA_IMAGE_TAG=$CHIA_IMAGE_TAG"
+            echo "EXPORTER_IMAGE_TAG=$EXPORTER_IMAGE_TAG"
+            echo "HEALTHCHECK_IMAGE_TAG=$HEALTHCHECK_IMAGE_TAG"
+            exit 1
+          fi
+
+          echo "CHIA_IMAGE_TAG=$CHIA_IMAGE_TAG" >> $GITHUB_ENV
+          echo "EXPORTER_IMAGE_TAG=$EXPORTER_IMAGE_TAG" >> $GITHUB_ENV
+          echo "HEALTHCHECK_IMAGE_TAG=$HEALTHCHECK_IMAGE_TAG" >> $GITHUB_ENV
+
+      - name: Build Container
+        uses: Chia-Network/actions/docker/build@main
+        with:
+          push: ${{ github.event_name != 'pull_request' }}
+          build-args: |
+            "CHIA_IMAGE_TAG=${{ env.CHIA_IMAGE_TAG }}"
+            "EXPORTER_IMAGE_TAG=${{ env.EXPORTER_IMAGE_TAG }}"
+            "HEALTHCHECK_IMAGE_TAG=${{ env.HEALTHCHECK_IMAGE_TAG }}"

.github/workflows/release.yml

@@ -20,6 +20,10 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Set dependency versions
+        run: |
+          echo "CHIA_OPERATOR_VERSION=$RELEASE_TAG" >> $GITHUB_ENV
+
       - name: Install kubectl
         run: |
           curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"

.github/workflows/test.yml

@@ -29,11 +29,6 @@ jobs:
         run: |
           make test
 
-  docker-build:
-    uses: Chia-Network/actions/.github/workflows/docker-build.yaml@main
-    with:
-      push: false
-
   test-controller-gen-ran:
     runs-on: "ubuntu-latest"
     timeout-minutes: 10

Dockerfile

@@ -1,7 +1,13 @@
 # Build the manager binary
 FROM golang:1 AS builder
-ARG TARGETOS
-ARG TARGETARCH
+
+ARG CHIA_IMAGE_TAG=latest
+ARG EXPORTER_IMAGE_TAG=latest
+ARG HEALTHCHECK_IMAGE_TAG=latest
+
+ENV CHIA_IMAGE_TAG=${CHIA_IMAGE_TAG}
+ENV EXPORTER_IMAGE_TAG=${EXPORTER_IMAGE_TAG}
+ENV HEALTHCHECK_IMAGE_TAG=${HEALTHCHECK_IMAGE_TAG}
 
 WORKDIR /workspace
 # Copy the Go Modules manifests
@@ -12,22 +18,19 @@ COPY go.sum go.sum
 RUN go mod download
 
 # Copy the go source
+COPY Makefile Makefile
 COPY cmd/main.go cmd/main.go
 COPY api/ api/
 COPY internal/ internal/
+COPY hack/ hack/
 
-# Build
-# the GOARCH has not a default value to allow the binary be built according to the host where the command
-# was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
-# the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
-# by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
-RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go
+RUN make build
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details
 FROM gcr.io/distroless/static:nonroot
 WORKDIR /
-COPY --from=builder /workspace/manager .
+COPY --from=builder /workspace/bin/manager .
 USER 65532:65532
 
 ENTRYPOINT ["/manager"]

Makefile

@@ -3,6 +3,17 @@ IMG ?= controller:latest
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.30.0
 
+# Optional version overrides for ldflags and yaml manifests
+CHIA_IMAGE_TAG      ?= latest
+EXPORTER_IMAGE_TAG  ?= latest
+HEALTHCHECK_IMAGE_TAG ?= latest
+CHIA_OPERATOR_VERSION ?= latest
+
+LD_FLAGS := \
+  -X 'github.com/chia-network/chia-operator/internal/controller/common/consts.DefaultChiaImageTag=$(CHIA_IMAGE_TAG)' \
+  -X 'github.com/chia-network/chia-operator/internal/controller/common/consts.DefaultChiaExporterImageTag=$(EXPORTER_IMAGE_TAG)' \
+  -X 'github.com/chia-network/chia-operator/internal/controller/common/consts.DefaultChiaHealthcheckImageTag=$(HEALTHCHECK_IMAGE_TAG)'
+
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
 GOBIN=$(shell go env GOPATH)/bin
@@ -80,15 +91,16 @@ lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 
 .PHONY: build
 build: manifests generate fmt vet ## Build manager binary.
-	go build -o bin/manager cmd/main.go
+	CGO_ENABLED=0 go build -ldflags="$(LD_FLAGS)" -o bin/manager cmd/main.go
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
-	go run ./cmd/main.go
+	go run -ldflags="$(LD_FLAGS)" ./cmd/main.go
 
 .PHONY: release
 release: manifests kustomize ## Build CRD and Operator manifests with kustomize.
 	mkdir -p release/
+	cd config/manager && $(KUSTOMIZE) edit set image ghcr.io/chia-network/chia-operator=ghcr.io/chia-network/chia-operator:$(CHIA_OPERATOR_VERSION)
 	$(KUSTOMIZE) build config/crd > release/crd.yaml
 	$(KUSTOMIZE) build config/default > release/manager.yaml
 	$(KUSTOMIZE) build config/prometheus > release/monitor.yaml

config/manager/kustomization.yaml

@@ -3,6 +3,6 @@ resources:
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 images:
-- name: controller
-  newName: controller
+- name: ghcr.io/chia-network/chia-operator
+  newName: ghcr.io/chia-network/chia-operator
   newTag: latest

internal/controller/common/consts/consts.go

@@ -37,7 +37,7 @@ const (
 )
 
 // API default image constants
-const (
+var (
 	// DefaultChiaImageName contains the default image name for the chia-docker image
 	DefaultChiaImageName = "ghcr.io/chia-network/chia"