Version commit hash

.github/workflows/build-images.yaml

@@ -46,6 +46,10 @@ jobs:
           image: ${{ env.OPERATOR_NAME }}
           tags: ${{ env.IMG_TAGS }}
           platforms: linux/amd64,linux/arm64
+          build-args: |
+            COMMIT=${{ github.sha }}
+            DIRTY=false
+
           dockerfiles: |
             ./Dockerfile
 
@@ -92,6 +96,9 @@ jobs:
           image: ${{ env.OPERATOR_NAME }}-bundle
           tags: ${{ needs.build.outputs.build-tags }}
           platforms: linux/amd64,linux/arm64
+          build-args: |
+            COMMIT=${{ github.sha }}
+            DIRTY=false
           dockerfiles: |
             ./bundle.Dockerfile
 

Dockerfile

@@ -3,6 +3,13 @@ FROM golang:1.21 as builder
 ARG TARGETOS
 ARG TARGETARCH
 
+ARG COMMIT
+ARG DIRTY
+
+ENV COMMIT=${COMMIT:-unknown}
+ENV DIRTY=${DIRTY:-unknown}
+
+
 WORKDIR /workspace
 # Copy the Go Modules manifests
 COPY go.mod go.mod
@@ -21,7 +28,7 @@ COPY internal/ internal/
 # 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 CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -ldflags "-X main.commit=${COMMIT} -X main.dirty=${DIRTY}" -a -o manager cmd/main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

Makefile

@@ -206,19 +206,25 @@ local-deploy-namespaced: docker-build kind-load-image ## Deploy the dns operator
 ##@ Build
 
 .PHONY: build
+build: COMMIT=$(shell git rev-parse HEAD || echo "unknown") 
+build: DIRTY=$(shell hack/check-git-dirty.sh || echo "unknown")
 build: manifests generate fmt vet ## Build manager binary.
-	go build -o bin/manager cmd/main.go
+	go build -ldflags "-X main.commit=${COMMIT} -X main.dirty=${DIRTY}" -o bin/manager cmd/main.go
 
 .PHONY: run
+run: COMMIT=$(shell git rev-parse HEAD || echo "unknown") 
+run: DIRTY=$(shell hack/check-git-dirty.sh || echo "unknown")
 run: manifests generate fmt vet ## Run a controller from your host.
-	go run ./cmd/main.go --zap-devel --provider inmemory,aws,google,azure
+	go run -ldflags "-X main.commit=${COMMIT} -X main.dirty=${DIRTY}" ./cmd/main.go --zap-devel --provider inmemory,aws,google,azure
 
 # If you wish built the manager image targeting other platforms you can use the --platform flag.
 # (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
 # More info: https://docs.docker.com/develop/develop-images/build_enhancements/
 .PHONY: docker-build
+docker-build: COMMIT=$(shell git rev-parse HEAD || echo "unknown") 
+docker-build: DIRTY=$(shell hack/check-git-dirty.sh || echo "unknown")
 docker-build: ## Build docker image with the manager.
-	$(CONTAINER_TOOL) build -t ${IMG} .
+	$(CONTAINER_TOOL) build -t ${IMG} . --build-arg COMMIT=$(COMMIT) --build-arg DIRTY=$(DIRTY)
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.

cmd/main.go

@@ -47,6 +47,9 @@ import (
 var (
 	scheme   = runtime.NewScheme()
 	setupLog = ctrl.Log.WithName("setup")
+	version  = "0.4.0-dev" // Change as versions are released
+	commit   string        // pass ldflag here to display commit hash
+	dirty    string        // must be string as passed in by ldflag to determine display .
 )
 
 const (
@@ -129,6 +132,16 @@ func main() {
 		providers = defaultProviders
 	}
 
+	// Display version here.
+
+	dnsInfoDisplay := fmt.Sprintf("dns-operator %s (%s-dirty)", version, commit)
+
+	if dirty == "false" {
+		dnsInfoDisplay = fmt.Sprintf("dns-operator %s (%s)", version, commit)
+	}
+
+	setupLog.Info(dnsInfoDisplay)
+
 	setupLog.Info("init provider factory", "providers", providers)
 	providerFactory, err := provider.NewFactory(mgr.GetClient(), providers)
 	if err != nil {

hack/check-git-dirty.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+if ! command -v git &>/dev/null 
+then
+    echo "git not found..." >&2
+    exit 1
+fi
+
+if output=$(git diff --stat 2>/dev/null)
+then
+[ -n "$output" ] && echo "true" || echo "false"
+else
+    # Not a git repository
+    exit 1
+fi