Kubebuilder scaffolding

.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+{
+  "name": "Kubebuilder DevContainer",
+  "image": "golang:1.25",
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/git:1": {}
+  },
+
+  "runArgs": ["--network=host"],
+
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "terminal.integrated.shell.linux": "/bin/bash"
+      },
+      "extensions": [
+        "ms-kubernetes-tools.vscode-kubernetes-tools",
+        "ms-azuretools.vscode-docker"
+      ]
+    }
+  },
+
+  "onCreateCommand": "bash .devcontainer/post-install.sh"
+}
+

.devcontainer/post-install.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -x
+
+curl -Lo ./kind https://kind.sigs.k8s.io/dl/latest/kind-linux-$(go env GOARCH)
+chmod +x ./kind
+mv ./kind /usr/local/bin/kind
+
+curl -L -o kubebuilder https://go.kubebuilder.io/dl/latest/linux/$(go env GOARCH)
+chmod +x kubebuilder
+mv kubebuilder /usr/local/bin/
+
+KUBECTL_VERSION=$(curl -L -s https://dl.k8s.io/release/stable.txt)
+curl -LO "https://dl.k8s.io/release/$KUBECTL_VERSION/bin/linux/$(go env GOARCH)/kubectl"
+chmod +x kubectl
+mv kubectl /usr/local/bin/kubectl
+
+docker network create -d=bridge --subnet=172.19.0.0/24 kind
+
+kind version
+kubebuilder version
+docker --version
+go version
+kubectl version --client

.dockerignore

@@ -1,3 +1,11 @@
 # More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
-# Ignore build and test binaries.
-bin/
+# Ignore everything by default and re-include only needed files
+**
+
+# Re-include Go source files (but not *_test.go)
+!**/*.go
+**/*_test.go
+
+# Re-include Go module files
+!go.mod
+!go.sum

.github/workflows/build-and-publish-image.yml

@@ -10,11 +10,12 @@ jobs:
   docker:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Go
-        uses: actions/setup-go@v4
+      - name: Clone the code
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
         with:
-          go-version: '1.23'
+          go-version-file: go.mod
       - name: Make test
         run: |
           make test

.github/workflows/lint-go.yml

@@ -12,17 +12,19 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v4
+      - name: Clone the code
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
         with:
-          go-version: '1.23'
+          go-version-file: go.mod
           cache: false
 
-      - uses: actions/checkout@v3
-
       - name: tidy
         uses: katexochen/go-tidy-check@v2
 
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+      - name: Run linter
+        uses: golangci/golangci-lint-action@v8
         with:
-          version: latest
+          version: v2.5.0

.github/workflows/test-go.yml

@@ -11,12 +11,13 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Clone the code
+        uses: actions/checkout@v4
 
-      - name: Set up Go
-        uses: actions/setup-go@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
         with:
-          go-version: '1.23'
+          go-version-file: go.mod
 
       - name: Make test
         uses: nick-fields/retry@v3

.gitignore

@@ -26,3 +26,6 @@ go.work
 *.swp
 *.swo
 *~
+
+# Kubeconfig might contain secrets
+*.kubeconfig

.golangci.yml

@@ -1,117 +1,120 @@
----
+version: "2"
 run:
-  # Timeout for analysis.
-  timeout: 5m
-
-  # Modules download mode (do not modify go.mod)
-  module-download-mode: readonly
-
-  # Include test files (see below to exclude certain linters)
   tests: true
-
-issues:
-  exclude-rules:
-    # Exclude certain linters for test code
-    - path: "_test\\.go"
-      linters:
-        - bodyclose
-        - dupl
-        - dogsled
-        - funlen
-
 output:
-  formats: colored-line-number
-  print-issued-lines: true
-  print-linter-name: true
-
-linters-settings:
-  depguard:
-    rules:
-      main:
-        # Packages that are not allowed where the value is a suggestion.
-        deny:
-          - pkg: "github.com/pkg/errors"
-            desc: Should be replaced by standard lib errors package
-  cyclop:
-    # The maximal code complexity to report.
-    max-complexity: 15
-    skip-tests: true
-  funlen:
-    lines: 100
-  nestif:
-    min-complexity: 6
-  forbidigo:
-    forbid:
-      - http\.NotFound.*  # return RFC 7807 problem details instead
-      - http\.Error.*  # return RFC 7807 problem details instead
-  gomoddirectives:
-    replace-allow-list:
-      - github.com/abbot/go-http-auth
-  tagliatelle:
-    case:
-      rules:
-        json: snake  # since betterstack uses snake instead of camel case for JSON
-
+  formats:
+    text:
+      path: stdout
+      print-linter-name: true
+      print-issued-lines: true
 linters:
-  disable-all: true
+  default: none
+  enable:
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - copyloopvar
+    - cyclop
+    - dogsled
+    - dupl
+    - durationcheck
+    - errcheck
+    - errname
+    - errorlint
+    - exhaustive
+    - exptostd
+    - fatcontext
+    - forbidigo
+    - funlen
+    - gocheckcompilerdirectives
+    - goconst
+    - gocritic
+    - gomoddirectives
+    - gomodguard
+    - goprintffuncname
+    - gosec
+    - govet
+    - ineffassign
+    - loggercheck
+    - makezero
+    - mirror
+    - misspell
+    - nakedret
+    - nestif
+    - nilerr
+    - nolintlint
+    - nosprintfhostport
+    - perfsprint
+    - predeclared
+    - promlinter
+    - reassign
+    - revive
+    - rowserrcheck
+    - sloglint
+    - sqlclosecheck
+    - staticcheck
+    - tagliatelle
+    - testableexamples
+    - tparallel
+    - unconvert
+    - unparam
+    - unused
+    - usestdlibvars
+    - usetesting
+    - wastedassign
+  settings:
+    cyclop:
+      max-complexity: 15
+    depguard:
+      rules:
+        main:
+          deny:
+            - pkg: github.com/pkg/errors
+              desc: Should be replaced by standard lib errors package
+    forbidigo:
+      forbid:
+        - pattern: http\.NotFound.*
+        - pattern: http\.Error.*
+    funlen:
+      lines: 100
+    gomoddirectives:
+      replace-allow-list:
+        - github.com/abbot/go-http-auth
+    nestif:
+      min-complexity: 6
+    tagliatelle:
+      case:
+        rules:
+          json: snake
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - bodyclose
+          - dogsled
+          - dupl
+          - funlen
+        path: _test\.go
+      - linters:
+          - cyclop
+        path: (.+)_test\.go
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
   enable:
-    # enabled by default by golangci-lint
-    - errcheck  # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
-    - gosimple  # specializes in simplifying a code
-    - govet  # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
-    - ineffassign  # detects when assignments to existing variables are not used
-    - staticcheck  # is a go vet on steroids, applying a ton of static analysis checks
-    - typecheck  # like the front-end of a Go compiler, parses and type-checks Go code
-    - unused  # checks for unused constants, variables, functions and types
-    # extra enabled by us
-    - asasalint  # checks for pass []any as any in variadic func(...any)
-    - asciicheck  # checks that your code does not contain non-ASCII identifiers
-    - bidichk  # checks for dangerous unicode character sequences
-    - bodyclose  # checks whether HTTP response body is closed successfully
-    - cyclop  # checks function and package cyclomatic complexity
-    - dupl  # tool for code clone detection
-    - durationcheck  # checks for two durations multiplied together
-    - dogsled  # find assignments/declarations with too many blank identifiers
-    - errname  # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
-    - errorlint  # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
-    - exhaustive  # checks exhaustiveness of enum switch statements
-    - exptostd  # detects functions from golang.org/x/exp/ that can be replaced by std functions
-    - copyloopvar  # checks for pointers to enclosing loop variables
-    - fatcontext  # detects nested contexts in loops and function literals
-    - forbidigo  # forbids identifiers
-    - funlen  # tool for detection of long functions
-    - gocheckcompilerdirectives  # validates go compiler directive comments (//go:)
-    - goconst  # finds repeated strings that could be replaced by a constant
-    - gocritic  # provides diagnostics that check for bugs, performance and style issues
-    - gofmt  # checks if the code is formatted according to 'gofmt' command
-    - goimports  # in addition to fixing imports, goimports also formats your code in the same style as gofmt
-    - gomoddirectives  # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
-    - gomodguard  # allow and block lists linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations
-    - goprintffuncname  # checks that printf-like functions are named with f at the end
-    - gosec  # inspects source code for security problems
-    - loggercheck  # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
-    - makezero  # finds slice declarations with non-zero initial length
-    - mirror  # reports wrong mirror patterns of bytes/strings usage
-    - misspell  # finds commonly misspelled English words
-    - nakedret  # finds naked returns in functions greater than a specified function length
-    - nestif  # reports deeply nested if statements
-    - nilerr  # finds the code that returns nil even if it checks that the error is not nil
-    - nolintlint  # reports ill-formed or insufficient nolint directives
-    - nosprintfhostport  # checks for misuse of Sprintf to construct a host with port in a URL
-    - perfsprint  # Golang linter for performance, aiming at usages of fmt.Sprintf which have faster alternatives
-    - predeclared  # finds code that shadows one of Go's predeclared identifiers
-    - promlinter  # checks Prometheus metrics naming via promlint
-    - reassign  # checks that package variables are not reassigned
-    - revive  # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
-    - rowserrcheck  # checks whether Err of rows is checked successfully
-    - sqlclosecheck  # checks that sql.Rows and sql.Stmt are closed
-    - sloglint  # A Go linter that ensures consistent code style when using log/slog
-    - tagliatelle  # checks the struct tags.
-    - usetesting  # detects using os.Setenv instead of t.Setenv since Go1.17
-    - testableexamples  # checks if examples are testable (have an expected output)
-    - tparallel  # detects inappropriate usage of t.Parallel() method in your Go test codes
-    - unconvert  # removes unnecessary type conversions
-    - unparam  # reports unused function parameters
-    - usestdlibvars  # detects the possibility to use variables/constants from the Go standard library
-    - wastedassign  # finds wasted assignment statements
-  fast: false
+    - gofmt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.23 AS builder
+FROM golang:1.25 AS builder
 ARG TARGETOS
 ARG TARGETARCH