build: Integrate with existing tooling

Author: jimmidyson

.github/workflows/goreleaser.yaml

@@ -0,0 +1,55 @@
+# Copyright 2023 D2iQ, Inc. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+name: goreleaser
+
+on:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: write
+  packages: write
+  issues: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Fetch all tags
+        run: git fetch --force --tags
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Gather tool versions
+        uses: endorama/asdf-parse-tool-versions@v1
+        id: versions
+
+      - name: Login to ghcr.io
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ fromJson(steps.versions.outputs.tools).golang }}
+          cache: true
+
+      - name: Run goreleaser
+        uses: goreleaser/goreleaser-action@v4
+        with:
+          distribution: goreleaser
+          version: ${{ fromJson(steps.versions.outputs.tools).goreleaser }}
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-main.yaml

@@ -0,0 +1,21 @@
+# Copyright 2023 D2iQ, Inc. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+name: release-please-main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: google-github-actions/[email protected]
+        id: release-please
+        with:
+          release-type: go
+          package-name: capi-runtime-extensions
+          pull-request-title-pattern: "build${scope}: release${component} ${version}"
+          changelog-notes-type: github

.github/workflows/release-please.yaml

@@ -1,3 +1,4 @@
 github.com/oligot/[email protected]
-gotest.tools/[email protected]
 github.com/segmentio/[email protected]
+gotest.tools/[email protected]
+sigs.k8s.io/controller-runtime/tools/[email protected]

.go-tools

@@ -21,7 +21,7 @@ changelog:
 release:
   footer: |
     ### Summary
-    **Full Changelog**: https://github.com/d2iq-labs/capi-runtime-extensions/compare/{{ .PreviousTag }}...{{ .Tag }}
+    **Full Changelog**: https://github.com/d2iq-labs/{{.ProjectName}}/compare/{{ .PreviousTag }}...{{ .Tag }}
 
 builds:
   - id: capi-runtime-extensions
@@ -61,14 +61,14 @@ dockers:
       #
       # For a release build the `-amd64` suffix will always be included and the `docker_manifests` specification below
       # will create the final multiplatform manifest to be pushed to the registry.
-      - 'd2iq-labs/capi-runtime-extensions:v{{trimprefix .Version "v"}}{{ if or (not .IsSnapshot) (not (eq .Runtime.Goarch "amd64")) }}-amd64{{ end }}'
+      - 'd2iq-labs/{{.ProjectName}}:v{{trimprefix .Version "v"}}{{ if or (not .IsSnapshot) (not (eq .Runtime.Goarch "amd64")) }}-amd64{{ end }}'
     use: buildx
     dockerfile: Dockerfile
     build_flag_templates:
       - "--platform=linux/amd64"
       - "--pull"
       - "--label=org.opencontainers.image.created={{.Date}}"
-      - "--label=org.opencontainers.image.title=capi-runtime-extensions"
+      - "--label=org.opencontainers.image.title={{.ProjectName}}"
       - "--label=org.opencontainers.image.revision={{.FullCommit}}"
       - "--label=org.opencontainers.image.version={{.Version}}"
       - "--label=org.opencontainers.image.source={{.GitURL}}"
@@ -80,23 +80,23 @@ dockers:
       #
       # For a release build the `-amd64v8` suffix will always be included and the `docker_manifests` specification below
       # will create the final multiplatform manifest to be pushed to the registry.
-    - 'd2iq-labs/capi-runtime-extensions:v{{trimprefix .Version "v"}}{{ if or (not .IsSnapshot) (not (eq .Runtime.Goarch "arm64")) }}-arm64v8{{ end }}'
+    - 'd2iq-labs/{{.ProjectName}}:v{{trimprefix .Version "v"}}{{ if or (not .IsSnapshot) (not (eq .Runtime.Goarch "arm64")) }}-arm64v8{{ end }}'
     use: buildx
     goarch: arm64
     dockerfile: Dockerfile
     build_flag_templates:
       - "--platform=linux/arm64"
       - "--pull"
       - "--label=org.opencontainers.image.created={{.Date}}"
-      - "--label=org.opencontainers.image.title=capi-runtime-extensions"
+      - "--label=org.opencontainers.image.title={{.ProjectName}}"
       - "--label=org.opencontainers.image.revision={{.FullCommit}}"
       - "--label=org.opencontainers.image.version={{.Version}}"
       - "--label=org.opencontainers.image.source={{.GitURL}}"
 docker_manifests:
-  - name_template: d2iq-labs/capi-runtime-extensions:v{{trimprefix .Version "v"}}
+  - name_template: d2iq-labs/{{.ProjectName}}:v{{trimprefix .Version "v"}}
     image_templates:
-    - d2iq-labs/capi-runtime-extensions:v{{trimprefix .Version "v"}}-amd64
-    - d2iq-labs/capi-runtime-extensions:v{{trimprefix .Version "v"}}-arm64v8
+    - d2iq-labs/{{.ProjectName}}:v{{trimprefix .Version "v"}}-amd64
+    - d2iq-labs/{{.ProjectName}}:v{{trimprefix .Version "v"}}-arm64v8
 checksum:
   name_template: 'checksums.txt'
 snapshot:

.goreleaser.yml

@@ -4,6 +4,8 @@ golang 1.19.5
 golangci-lint 1.50.1
 goreleaser 1.15.0
 helm 3.11.0
+kube-controller-tools 0.11.2
+kustomize 4.5.7
 pre-commit 3.0.2
 shfmt 3.6.0
 upx 4.0.2

.tool-versions

@@ -3,4 +3,7 @@
 
 REPO_ROOT := $(CURDIR)
 
+# Versions for tools that are not managed by asdf.
+ENVTEST_VERSION=1.25.x
+
 include make/all.mk

Makefile

@@ -1,21 +1,24 @@
+// Copyright 2023 D2iQ, Inc. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package main
 
 import (
 	"context"
 	"flag"
 	"net/http"
 	"os"
+	"time"
 
 	"github.com/spf13/pflag"
 	cliflag "k8s.io/component-base/cli/flag"
 	"k8s.io/component-base/logs"
 	logsv1 "k8s.io/component-base/logs/api/v1"
 	"k8s.io/klog/v2"
-	ctrl "sigs.k8s.io/controller-runtime"
-
 	runtimecatalog "sigs.k8s.io/cluster-api/exp/runtime/catalog"
 	runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
 	"sigs.k8s.io/cluster-api/exp/runtime/server"
+	ctrl "sigs.k8s.io/controller-runtime"
 )
 
 var (
@@ -29,11 +32,6 @@ var (
 	logOptions      = logs.NewOptions()
 )
 
-func init() {
-	// Adds to the catalog all the RuntimeHooks defined in cluster API.
-	_ = runtimehooksv1.AddToCatalog(catalog)
-}
-
 // InitFlags initializes the flags.
 func InitFlags(fs *pflag.FlagSet) {
 	// Initialize logs flags using Kubernetes component-base machinery.
@@ -52,6 +50,8 @@ func InitFlags(fs *pflag.FlagSet) {
 }
 
 func main() {
+	_ = runtimehooksv1.AddToCatalog(catalog)
+
 	// Creates a logger to be used during the main func.
 	setupLog := ctrl.Log.WithName("main")
 
@@ -74,7 +74,14 @@ func main() {
 	if profilerAddress != "" {
 		klog.Infof("Profiler listening for requests at %s", profilerAddress)
 		go func() {
-			klog.Info(http.ListenAndServe(profilerAddress, nil))
+			profilerServer := &http.Server{
+				Addr:              profilerAddress,
+				Handler:           nil,
+				MaxHeaderBytes:    1 << 20,
+				IdleTimeout:       90 * time.Second, // matches http.DefaultTransport keep-alive timeout
+				ReadHeaderTimeout: 32 * time.Second,
+			}
+			klog.Info(profilerServer.ListenAndServe())
 		}()
 	}
 
@@ -118,13 +125,21 @@ func main() {
 	}
 }
 
-func DoBeforeClusterCreate(ctx context.Context, request *runtimehooksv1.BeforeClusterCreateRequest, response *runtimehooksv1.BeforeClusterCreateResponse) {
+func DoBeforeClusterCreate(
+	ctx context.Context,
+	request *runtimehooksv1.BeforeClusterCreateRequest,
+	response *runtimehooksv1.BeforeClusterCreateResponse,
+) {
 	log := ctrl.LoggerFrom(ctx)
 	log.Info("BeforeClusterCreate is called")
 	// Your implementation
 }
 
-func DoBeforeClusterUpgrade(ctx context.Context, request *runtimehooksv1.BeforeClusterUpgradeRequest, response *runtimehooksv1.BeforeClusterUpgradeResponse) {
+func DoBeforeClusterUpgrade(
+	ctx context.Context,
+	request *runtimehooksv1.BeforeClusterUpgradeRequest,
+	response *runtimehooksv1.BeforeClusterUpgradeResponse,
+) {
 	log := ctrl.LoggerFrom(ctx)
 	log.Info("BeforeClusterUpgrade is called")
 	// Your implementation

main.go renamed to cmd/capi-runtime-extensions/main.go

@@ -16,6 +16,7 @@ export GOARCH := $(shell go env GOARCH)
 endif
 
 define go_test
+	source <(setup-envtest use -p env $(ENVTEST_VERSION)) && \
 	gotestsum \
 		--jsonfile test.json \
 		--junitfile junit-report.xml \
@@ -45,7 +46,7 @@ endif
 
 .PHONY: test.%
 test.%: ## Runs go tests for a specific module
-test.%: install-tool.go.gotestsum; $(info $(M) running tests$(if $(GOTEST_RUN), matching "$(GOTEST_RUN)") for $* module)
+test.%: install-tool.go.gotestsum install-tool.go.setup-envtest ; $(info $(M) running tests$(if $(GOTEST_RUN), matching "$(GOTEST_RUN)") for $* module)
 	$(if $(filter-out root,$*),cd $* && )$(call go_test)
 
 .PHONY: integration-test
@@ -156,8 +157,10 @@ go-clean.%: install-tool.golang; $(info $(M) running go clean for $* module)
 
 .PHONY: go-generate
 go-generate: ## Runs go generate
-go-generate: install-tool.golang ; $(info $(M) running go generate)
+go-generate: install-tool.golang install-tool.kube-controller-tools ; $(info $(M) running go generate)
 	go generate -x ./...
+	controller-gen rbac:roleName=manager-role webhook paths="./..."
+	controller-gen object:headerFile="header.txt" paths="./..."
 
 .PHONY: go-mod-upgrade
 go-mod-upgrade: ## Interactive check for direct module dependency upgrades

make/go.mk

@@ -10,7 +10,7 @@ endif
 
 .PHONY: build-snapshot
 build-snapshot: ## Builds a snapshot with goreleaser
-build-snapshot: dockerauth install-tool.goreleaser install-tool.golang ; $(info $(M) building snapshot $*)
+build-snapshot: dockerauth install-tool.goreleaser install-tool.golang go-generate ; $(info $(M) building snapshot $*)
 	goreleaser --debug=$(GORELEASER_DEBUG) \
 		build \
 		--snapshot \
@@ -21,7 +21,7 @@ build-snapshot: dockerauth install-tool.goreleaser install-tool.golang ; $(info
 
 .PHONY: release
 release: ## Builds a release with goreleaser
-release: dockerauth install-tool.goreleaser  install-tool.golang ; $(info $(M) building release $*)
+release: dockerauth install-tool.goreleaser install-tool.golang go-generate ; $(info $(M) building release $*)
 	goreleaser --debug=$(GORELEASER_DEBUG) \
 		release \
 		--rm-dist \
@@ -31,7 +31,7 @@ release: dockerauth install-tool.goreleaser  install-tool.golang ; $(info $(M) b
 
 .PHONY: release-snapshot
 release-snapshot: ## Builds a snapshot release with goreleaser
-release-snapshot: dockerauth install-tool.goreleaser  install-tool.golang ; $(info $(M) building snapshot release $*)
+release-snapshot: dockerauth install-tool.goreleaser install-tool.golang go-generate ; $(info $(M) building snapshot release $*)
 	goreleaser --debug=$(GORELEASER_DEBUG) \
 		release \
 		--snapshot \