feat(ci): attach release manifests for clusterctl

Author: vknabel

.github/workflows/release-drafter.yaml

@@ -5,11 +5,42 @@ on:
   push:
     branches:
       - main
+permissions:
+  contents: write
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: release-drafter/release-drafter@v6
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+
+      - name: install kustomize
+        run: |
+          make kustomize
+      - name: generate release artifacts
+        env:
+          IMG_TAG: ${{ github.ref_name }}
+          RELEASE_DIR: .release
+        run: |
+          make release-manifests
+
+      - name: Attach release manifests
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          name: v${{ RESOLVED_VERSION }}
+          draft: true
+          fail_on_unmatched_files: true
+          files: .release/*

.gitignore

@@ -7,6 +7,7 @@
 bin/*
 test/external-crds
 Dockerfile.cross
+.release
 
 infrastructure-components.yaml
 .capms-cluster-kubeconfig.yaml

Makefile

@@ -1,7 +1,10 @@
 # Image URL to use all building/pushing image targets
-IMG ?= capms-controller:latest
+IMG ?= ghcr.io/metal-stack/capms-controller:latest
+IMG_NAME ?= ghcr.io/metal-stack/capms-controller
+IMG_TAG ?= latest
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.31.0
+RELEASE_DIR ?= .release
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -45,8 +48,9 @@ help: ## Display this help.
 
 .PHONY: release-manifests
 release-manifests: $(KUSTOMIZE) ## Builds the manifests to publish with a release
-	$(KUSTOMIZE) build config/default > infrastructure-components.yaml
-	# cp metadata.yaml $(RELEASE_DIR)/metadata.yaml
+	$(KUSTOMIZE) build config/default > $(RELEASE_DIR)/infrastructure-components.yaml
+	sed -i 's!image: $(IMG_NAME):latest!image: $(IMG_NAME):$(IMG_TAG)!' $(RELEASE_DIR)/infrastructure-components.yaml
+	cp metadata.yaml $(RELEASE_DIR)/metadata.yaml
 	# cp examples/clusterctl-templates/clusterctl-cluster.yaml $(RELEASE_DIR)/cluster-template.yaml
 	# cp examples/clusterctl-templates/example_variables.rc $(RELEASE_DIR)/example_variables.rc
 
@@ -55,7 +59,7 @@ release-manifests: $(KUSTOMIZE) ## Builds the manifests to publish with a releas
 .PHONY: push-to-capi-lab
 push-to-capi-lab: generate manifests build install deploy
 	docker build -t $(IMG) -f Dockerfile.dev .
-	kind --name metal-control-plane load docker-image capms-controller:latest
+	kind --name metal-control-plane load docker-image $(IMG)
 	kubectl --kubeconfig=$(KUBECONFIG) patch deployments.apps -n capms-system capms-controller-manager --patch='{"spec":{"template":{"spec":{"containers":[{"name": "manager","imagePullPolicy":"IfNotPresent","image":"$(IMG)"}]}}}}'
 	kubectl --kubeconfig=$(KUBECONFIG) delete pod -n capms-system -l control-plane=controller-manager
 

capi-lab/Makefile

@@ -1,7 +1,7 @@
 .DEFAULT_GOAL := up
 
 KUBECONFIG := $(shell pwd)/mini-lab/.kubeconfig
-IMG ?= capms-controller:latest
+IMG ?= ghcr.io/metal-stack/capms-controller:latest
 
 .PHONY: up
 up: bake deploy-capi

config/manager/manager.yaml

@@ -33,48 +33,48 @@ spec:
         seccompProfile:
           type: RuntimeDefault
       containers:
-      - env:
-          - name: METAL_API_URL
-            valueFrom:
-              secretKeyRef:
-                name: controller-manager-config
-                key: api-url
-          - name: METAL_API_HMAC
-            valueFrom:
-              secretKeyRef:
-                name: controller-manager-config
-                key: api-hmac
-        command:
-        - /manager
-        args:
-          - --leader-elect
-          - --health-probe-bind-address=:8081
-        image: capms-controller:latest
-        imagePullPolicy: IfNotPresent
-        name: manager
-        securityContext:
-          allowPrivilegeEscalation: false
-          capabilities:
-            drop:
-            - "ALL"
-        livenessProbe:
-          httpGet:
-            path: /healthz
-            port: 8081
-          initialDelaySeconds: 15
-          periodSeconds: 20
-        readinessProbe:
-          httpGet:
-            path: /readyz
-            port: 8081
-          initialDelaySeconds: 5
-          periodSeconds: 10
-        resources:
-          limits:
-            cpu: 500m
-            memory: 128Mi
-          requests:
-            cpu: 10m
-            memory: 64Mi
+        - env:
+            - name: METAL_API_URL
+              valueFrom:
+                secretKeyRef:
+                  name: controller-manager-config
+                  key: api-url
+            - name: METAL_API_HMAC
+              valueFrom:
+                secretKeyRef:
+                  name: controller-manager-config
+                  key: api-hmac
+          command:
+            - /manager
+          args:
+            - --leader-elect
+            - --health-probe-bind-address=:8081
+          image: ghcr.io/metal-stack/capms-controller:latest
+          imagePullPolicy: IfNotPresent
+          name: manager
+          securityContext:
+            allowPrivilegeEscalation: false
+            capabilities:
+              drop:
+                - "ALL"
+          livenessProbe:
+            httpGet:
+              path: /healthz
+              port: 8081
+            initialDelaySeconds: 15
+            periodSeconds: 20
+          readinessProbe:
+            httpGet:
+              path: /readyz
+              port: 8081
+            initialDelaySeconds: 5
+            periodSeconds: 10
+          resources:
+            limits:
+              cpu: 500m
+              memory: 128Mi
+            requests:
+              cpu: 10m
+              memory: 64Mi
       serviceAccountName: controller-manager
       terminationGracePeriodSeconds: 10

metadata.yaml

@@ -0,0 +1,10 @@
+# maps release series of major.minor to cluster-api contract version
+# the contract version may change between minor or major versions, but *not*
+# between patch versions.
+#
+# update this file only when a new major or minor version is released
+apiVersion: clusterctl.cluster.x-k8s.io/v1alpha3
+releaseSeries:
+  - major: 0
+    minor: 1
+    contract: v1beta1

test/e2e/e2e_suite_test.go

@@ -43,7 +43,7 @@ var (
 
 	// projectImage is the name of the image which will be build and loaded
 	// with the code source changes to be tested.
-	projectImage = "capms-controller:latest"
+	projectImage = "ghcr.io/metal-stack/capms-controller:latest"
 )
 
 // TestE2E runs the end-to-end (e2e) test suite for the project. These tests execute in an isolated,