Publish gitopssets-controller helm chart with github-actions (#51)

* Add and copy license into chart
* Publish chart to ghcr
* Strip leading v from chart version
* Include version when building
* Log version earlier during startup
* Review feedback
- bump helm to latests
- bump golang to 1.20
- move version.go to root

Author: foot

.github/workflows/ci.yaml

@@ -12,6 +12,7 @@ on:
   pull_request_target:
     types:
       - closed
+  workflow_dispatch:
 
 env:
   REGISTRY: ghcr.io
@@ -36,7 +37,7 @@ jobs:
       - name: Setup
         uses: actions/setup-go@v3
         with:
-          go-version: 1.19.x
+          go-version: 1.20.x
           cache: true
 
       - name: Test
@@ -54,6 +55,10 @@ jobs:
           fetch-depth: 0 # for git describe
           ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
+      - name: Get version
+        id: get_version
+        run: echo "::set-output name=VERSION::$(make version)"
+
       - name: Log in to the Container registry
         uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
         with:
@@ -72,7 +77,7 @@ jobs:
           GITHUB_BUILD_USERNAME: ${{ secrets.BUILD_BOT_USER }}
           GITHUB_BUILD_TOKEN: ${{ secrets.BUILD_BOT_PERSONAL_ACCESS_TOKEN }}
         run: git config --global url."https://${GITHUB_BUILD_USERNAME}:${GITHUB_BUILD_TOKEN}@github.com".insteadOf "https://github.com"
-        
+
       - name: go mod vendor
         run: go mod vendor
 
@@ -82,4 +87,43 @@ jobs:
           context: .
           push: true
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: VERSION=${{ steps.get_version.outputs.VERSION }}
+
+  build-push-helm-chart:
+    runs-on: ubuntu-latest
+    needs: [build, test]
+    # only run on tag
+    if: startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      contents: read # for actions/checkout to fetch code
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # for git describe
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+
+      - name: Configure git for private modules
+        env:
+          GITHUB_BUILD_USERNAME: ${{ secrets.BUILD_BOT_USER }}
+          GITHUB_BUILD_TOKEN: ${{ secrets.BUILD_BOT_PERSONAL_ACCESS_TOKEN }}
+        run: git config --global url."https://${GITHUB_BUILD_USERNAME}:${GITHUB_BUILD_TOKEN}@github.com".insteadOf "https://github.com"
+
+      - name: Install Helm
+        run: |
+          wget --no-verbose https://get.helm.sh/helm-v3.12.1-linux-amd64.tar.gz
+          tar -zxvf helm-v3.12.1-linux-amd64.tar.gz
+          mv linux-amd64/helm /usr/local/bin/helm
+          helm version
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.BUILD_BOT_USER_WRITE_PACKAGES_PAT }}
+
+      - name: Build and publish chart
+        run: |
+          make publish-helm-chart

Dockerfile

@@ -1,7 +1,8 @@
 # Build the manager binary
-FROM golang:1.19 as builder
+FROM golang:1.20 as builder
 ARG TARGETOS
 ARG TARGETARCH
+ARG VERSION
 
 WORKDIR /workspace
 # Copy the Go Modules manifests
@@ -11,6 +12,7 @@ COPY vendor vendor
 
 # Copy the go source
 COPY main.go main.go
+COPY version.go version.go
 COPY api/ api/
 COPY controllers/ controllers/
 COPY pkg/ pkg/
@@ -20,7 +22,7 @@ COPY pkg/ pkg/
 # 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 main.go
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager -ldflags "-X main.Version=${VERSION}" main.go version.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

LICENSE

@@ -0,0 +1,2 @@
+GitOpsSets is under the same license and commercial agreement as Weave GitOps Enterprise, and can only be used in conjunction.
+

Makefile

@@ -1,10 +1,15 @@
 
+VERSION ?= $(shell git describe --tags --always)
+# Strip off leading `v`: v0.12.0 -> 0.12.0
+# Seems to be idiomatic for chart versions: https://helm.sh/docs/topics/charts/#the-chart-file
+CHART_VERSION := $(shell echo $(VERSION) | sed 's/^v//')
+
 # Image URL to use all building/pushing image targets
-IMG ?= ghcr.io/weaveworks/gitopssets-controller:latest
+IMG ?= ghcr.io/weaveworks/gitopssets-controller:${VERSION}
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.25.0
 GEN_API_REF_DOCS_VERSION ?= e327d0730470cbd61b06300f81c5fcf91c23c113
-
+CHART_REGISTRY ?= ghcr.io/weaveworks/charts
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -69,7 +74,7 @@ e2e-tests: manifests generate fmt vet envtest ## Run tests.
 
 .PHONY: build
 build: manifests generate fmt vet ## Build manager binary.
-	go build -o bin/manager main.go
+	go build -o bin/manager -ldflags "-X main.Version=${VERSION}" main.go version.go
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
@@ -80,12 +85,15 @@ vendor: ## Update vendor directory.
 	go mod tidy
 	go mod vendor
 
+version:
+	@echo $(VERSION)
+
 # 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: test vendor ## Build docker image with the manager.
-	docker build -t ${IMG} .
+	docker build -t ${IMG} --build-arg VERSION=${VERSION} .
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.
@@ -182,6 +190,18 @@ helmify:
 helm: manifests kustomize helmify
 	$(KUSTOMIZE) build config/default | $(HELMIFY) -crd-dir ../weave-gitops-enterprise/charts/gitopssets-controller
 
+.PHONY: helm-chart
+helm-chart: manifests kustomize helmify
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default | $(HELMIFY) -crd-dir charts/gitopssets-controller
+	echo "fullnameOverride: gitopssets" >> charts/gitopssets-controller/values.yaml
+	cp LICENSE charts/gitopssets-controller/LICENSE
+	helm lint charts/gitopssets-controller
+	helm package charts/gitopssets-controller --app-version $(VERSION) --version $(CHART_VERSION) --destination /tmp/helm-repo
+
+publish-helm-chart: helm-chart
+	helm push /tmp/helm-repo/gitopssets-controller-${CHART_VERSION}.tgz oci://${CHART_REGISTRY}
+
 .PHONY: download-crds
 download-crds:
 	@curl https://raw.githubusercontent.com/fluxcd/source-controller/main/config/crd/bases/source.toolkit.fluxcd.io_gitrepositories.yaml > tests/e2e/testdata/crds/source.toolkit.fluxcd.io_gitrepositories.yaml

main.go

@@ -63,6 +63,15 @@ func main() {
 
 	flag.Parse()
 
+	watchNamespace := ""
+	if !watchAllNamespaces {
+		watchNamespace = os.Getenv("RUNTIME_NAMESPACE")
+	}
+
+	ctrl.SetLogger(logger.NewLogger(logOptions))
+
+	setupLog.Info("configuring manager", "version", Version)
+
 	err := setup.ValidateEnabledGenerators(enabledGenerators)
 	if err != nil {
 		setupLog.Error(err, "invalid enabled generators")
@@ -76,12 +85,6 @@ func main() {
 		os.Exit(1)
 	}
 
-	watchNamespace := ""
-	if !watchAllNamespaces {
-		watchNamespace = os.Getenv("RUNTIME_NAMESPACE")
-	}
-
-	ctrl.SetLogger(logger.NewLogger(logOptions))
 	restConfig := runtimeclient.GetConfigOrDie(clientOptions)
 	mgr, err := ctrl.NewManager(restConfig, ctrl.Options{
 		Scheme:                 scheme,

version.go

@@ -0,0 +1,3 @@
+package main
+
+var Version = "dev"