rebase onto latest kubernetes-sigs/controller-tools@master (1.30)

.github/dependabot.yml

@@ -1,34 +1,37 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
 # Please see the documentation for all configuration options:
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
 version: 2
 updates:
+# GitHub Actions
+- package-ecosystem: "github-actions"
+  # Workflow files stored in the
+  # default location of `.github/workflows`
+  directory: "/"
+  schedule:
+    interval: "weekly"
+  groups:
+    all-github-actions:
+      patterns: [ "*" ]
+  commit-message:
+    prefix: ":seedling:"
+  labels:
+  - "ok-to-test"
 
-  # Maintain dependencies for GitHub Actions
-  - package-ecosystem: "github-actions"
-    # Workflow files stored in the
-    # default location of `.github/workflows`
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    commit-message:
-      prefix: ":seedling:"
-    labels:
-      - "ok-to-test"
-
-  # Maintain dependencies for go
-  - package-ecosystem: "gomod"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    commit-message:
-      prefix: ":seedling:"
-    labels:
-      - "ok-to-test"
-    # Ignore K8 packages as these are done manually
-    ignore:
-      - dependency-name: "k8s.io/api"
-      - dependency-name: "k8s.io/apiextensions-apiserver"
-      - dependency-name: "k8s.io/apimachinery"
+# Go modules
+- package-ecosystem: "gomod"
+  directory: "/"
+  schedule:
+    interval: "weekly"
+  # group all dependencies with a k8s.io prefix into a single PR.
+  groups:
+    all-go-mod-patch-and-minor:
+      patterns: [ "*" ]
+      update-types: [ "patch", "minor" ]
+  ignore:
+  # Ignore k8s and its transitives modules as they are upgraded manually.
+  - dependency-name: "k8s.io/*"
+    update-types: [ "version-update:semver-major", "version-update:semver-minor" ]
+  commit-message:
+    prefix: ":seedling:"
+  labels:
+    - "ok-to-test"

.github/workflows/golangci-lint.yml

@@ -0,0 +1,37 @@
+name: golangci-lint
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+    branches:
+      - main
+      - master
+
+permissions:
+  # Required: allow read access to the content for analysis.
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  pull-requests: read
+  # Optional: Allow write access to checks to allow the action to annotate code in the PR.
+  checks: write
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        working-directory:
+          - ""
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # tag=v5.0.2
+        with:
+          go-version: "1.22"
+          cache: false
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # tag=v4.1.7
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@a4f60bb28d35aeee14e6880718e0c85ff1882e64 # tag=v6.0.1
+        with:
+          version: v1.57.2
+          args: --out-format=colored-line-number
+          working-directory: ${{matrix.working-directory}}

.github/workflows/pr-dependabot.yaml

@@ -0,0 +1,35 @@
+name: PR dependabot go modules fix
+
+# This action runs on PRs opened by dependabot and updates modules.
+on:
+  pull_request:
+    branches:
+      - dependabot/**
+  push:
+    branches:
+      - dependabot/**
+  workflow_dispatch:
+
+permissions:
+  contents: write # Allow to update the PR.
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # tag=v4.1.7
+    - name: Set up Go
+      uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # tag=v5.0.2
+      with:
+        go-version: '1.22'
+    - name: Update all modules
+      run: make modules
+    - uses: EndBug/add-and-commit@a94899bca583c204427a224a7af87c02f9b325d5 # tag=v9.1.4
+      name: Commit changes
+      with:
+        author_name: dependabot[bot]
+        author_email: 49699333+dependabot[bot]@users.noreply.github.com
+        default_author: github_actor
+        message: 'Update generated code'

.github/workflows/tools-releases.yml

@@ -0,0 +1,61 @@
+name: Package controller-runtime envtest
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - 'hack/envtest/_matrix/*.yaml'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # tag=v4.1.7
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@6b2903bdce6310cfbddd87c418f253cf29b2dec9 # tag=v44.5.6
+        with:
+          files: |
+            hack/envtest/_matrix/*.yaml
+      - name: Setup package release version
+        id: release-version
+        run: |
+            if [[ ${{ steps.changed-files.outputs.all_changed_files_count }} != 1 ]]; then
+              echo "One Kubernetes patch version files should be changed for a release, found ${{ steps.changed-files.outputs.all_changed_files_count }}"
+              exit 1
+            fi
+
+            for changed_file in ${{ steps.changed-files.outputs.all_changed_files }}; do
+              export KUBERNETES_VERSION=$(echo "${changed_file}" | grep -oP '(?<=/)[^/]+(?=\.yaml)')
+              echo "KUBERNETES_VERSION=$KUBERNETES_VERSION" >> $GITHUB_ENV
+            done
+      - name: Build packages
+        run: |
+          make release-envtest KUBERNETES_VERSION=${{ env.KUBERNETES_VERSION }}
+      - name: Release
+        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # tag=v2.0.8
+        with:
+          tag_name: envtest-${{ env.KUBERNETES_VERSION }}
+          draft: false
+          make_latest: false
+          files: |
+            out/envtest-*.tar.gz
+            out/envtest-*.tar.gz.sha512
+          fail_on_unmatched_files: true
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # tag=v6.1.0
+        with:
+          commit-message: Promote envtest release for Kubernetes ${{ env.KUBERNETES_VERSION }}
+          title: ":seedling: Promotion of envtest release for Kubernetes ${{ env.KUBERNETES_VERSION }}"
+          body: |
+            This PR promotes the envtest release for Kubernetes ${{ env.KUBERNETES_VERSION }}.
+          branch: promote-envtest-${{ env.KUBERNETES_VERSION }}
+          add-paths: |
+            envtest-releases.yaml

.github/workflows/verify.yml

@@ -1,8 +1,9 @@
-name: PR Verifier
-
 on:
   pull_request_target:
-    types: [opened, edited, reopened]
+    types: [opened, edited, reopened, synchronize]
+
+permissions:
+  checks: write # Allow access to checks to write check runs.
 
 jobs:
   verify:
@@ -11,6 +12,6 @@ jobs:
     steps:
     - name: Verifier action
       id: verifier
-      uses: kubernetes-sigs/kubebuilder-release-tools@v0.2.0
+      uses: kubernetes-sigs/kubebuilder-release-tools@012269a88fa4c034a0acf1ba84c26b195c0dbab4 # tag=v0.4.3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -16,3 +16,10 @@
 *.swp
 *.swo
 *~
+
+# Tools binaries.
+out
+hack/tools/bin
+
+junit-report.xml
+/artifacts

.golangci.yml

@@ -2,4 +2,11 @@ run:
   modules-download-mode: readonly
   # Increase the default deadline from 1m as some module operations can take a
   # while if uncached!
-  deadline: 5m
+  timeout: 10m
+
+issues:
+  exclude-rules:
+    # Dot imports for gomega and ginkgo are allowed
+    # within test files.
+  - path: _test\.go
+    text: should not use dot imports

Makefile

@@ -1,2 +1,137 @@
-test-all:
+#!/usr/bin/env bash
+
+#  Copyright 2024 The Kubernetes Authors.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+# If you update this file, please follow
+# https://suva.sh/posts/well-documented-makefiles
+
+## --------------------------------------
+## General
+## --------------------------------------
+
+SHELL:=/usr/bin/env bash
+.DEFAULT_GOAL:=help
+
+# Use GOPROXY environment variable if set
+GOPROXY := $(shell go env GOPROXY)
+ifeq ($(GOPROXY),)
+GOPROXY := https://proxy.golang.org
+endif
+export GOPROXY
+
+# Active module mode, as we use go modules to manage dependencies
+export GO111MODULE=on
+
+# Tools.
+ENVTEST_DIR := hack/envtest
+ENVTEST_MATRIX_DIR := $(ENVTEST_DIR)/_matrix
+TOOLS_DIR := hack/tools
+TOOLS_BIN_DIR := $(abspath $(TOOLS_DIR)/bin)
+GOLANGCI_LINT := $(abspath $(TOOLS_BIN_DIR)/golangci-lint)
+GO_INSTALL := ./hack/go-install.sh
+
+## --------------------------------------
+## Binaries
+## --------------------------------------
+
+GOLANGCI_LINT_BIN := golangci-lint
+GOLANGCI_LINT_VER := $(shell cat .github/workflows/golangci-lint.yml | grep [[:space:]]version: | sed 's/.*version: //')
+GOLANGCI_LINT := $(abspath $(TOOLS_BIN_DIR)/$(GOLANGCI_LINT_BIN)-$(GOLANGCI_LINT_VER))
+GOLANGCI_LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint
+
+$(GOLANGCI_LINT): # Build golangci-lint from tools folder.
+	GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(GOLANGCI_LINT_PKG) $(GOLANGCI_LINT_BIN) $(GOLANGCI_LINT_VER)
+
+## --------------------------------------
+## Linting
+## --------------------------------------
+
+.PHONY: lint
+lint: $(GOLANGCI_LINT) ## Lint codebase
+	$(GOLANGCI_LINT) run -v $(GOLANGCI_LINT_EXTRA_ARGS)
+	cd tools/setup-envtest; $(GOLANGCI_LINT) run -v $(GOLANGCI_LINT_EXTRA_ARGS)
+
+.PHONY: lint-fix
+lint-fix: $(GOLANGCI_LINT) ## Lint the codebase and run auto-fixers if supported by the linter.
+	GOLANGCI_LINT_EXTRA_ARGS=--fix $(MAKE) lint
+
+## --------------------------------------
+## Testing
+## --------------------------------------
+
+.PHONY: test
+test: ## Run the test.sh script which will check all.
 	TRACE=1 ./test.sh
+
+test-all:
+	$(MAKE) test
+
+.PHONY: modules
+modules: ## Runs go mod to ensure modules are up to date.
+	go mod tidy
+
+## --------------------------------------
+## Cleanup / Verification
+## --------------------------------------
+
+.PHONY: clean
+clean: ## Cleanup.
+	$(GOLANGCI_LINT) cache clean
+	$(MAKE) clean-bin
+
+.PHONY: clean-bin
+clean-bin: ## Remove all generated binaries.
+	rm -rf hack/tools/bin
+
+.PHONE: clean-release
+clean-release: ## Remove all generated release binaries.
+	rm -rf $(RELEASE_DIR)
+
+## --------------------------------------
+## Envtest Build
+## --------------------------------------
+
+RELEASE_DIR := out
+
+.PHONY: $(RELEASE_DIR)
+$(RELEASE_DIR):
+	mkdir -p $(RELEASE_DIR)/
+
+.PHONY: release-envtest
+release-envtest: clean-release ## Build the envtest binaries by operating system.
+	OS=linux ARCH=amd64 $(MAKE) release-envtest-docker-build
+	OS=linux ARCH=arm64 $(MAKE) release-envtest-docker-build
+	OS=linux ARCH=ppc64le $(MAKE) release-envtest-docker-build
+	OS=linux ARCH=s390x $(MAKE) release-envtest-docker-build
+	OS=darwin ARCH=amd64 $(MAKE) release-envtest-docker-build
+	OS=darwin ARCH=arm64 $(MAKE) release-envtest-docker-build
+	OS=windows ARCH=amd64 $(MAKE) release-envtest-docker-build
+	./hack/envtest/update-releases.sh
+
+.PHONY: release-envtest-docker-build
+release-envtest-docker-build: $(RELEASE_DIR) ## Build the envtest binaries.
+	@: $(if $(KUBERNETES_VERSION),,$(error KUBERNETES_VERSION is not set))
+	@: $(if $(OS),,$(error OS is not set))
+	@: $(if $(ARCH),,$(error ARCH is not set))
+	docker buildx build \
+		--file ./hack/envtest/$(OS)/Dockerfile \
+		--build-arg KUBERNETES_VERSION=$(KUBERNETES_VERSION) \
+		--build-arg GO_VERSION=$(shell yq eval '.go' $(ENVTEST_MATRIX_DIR)/$(KUBERNETES_VERSION).yaml) \
+		--build-arg ETCD_VERSION=$(shell yq eval '.etcd' $(ENVTEST_MATRIX_DIR)/$(KUBERNETES_VERSION).yaml) \
+		--build-arg OS=$(OS) \
+		--build-arg ARCH=$(ARCH) \
+		--tag sigs.k8s.io/controller-tools/envtest:$(KUBERNETES_VERSION)-$(OS)-$(ARCH) \
+		--output type=local,dest=$(RELEASE_DIR) \
+		.