📖 Update book-v4 regards release v4.7.0

.github/workflows/apidiff.yml

@@ -24,7 +24,7 @@ jobs:
         with:
           go-version-file: go.mod
       - name: Execute go-apidiff
-        uses: joelanford/[email protected].2
+        uses: joelanford/[email protected].3
         with:
           compare-imports: true
           print-compatible: true

.github/workflows/external-plugin.yml

@@ -18,57 +18,14 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     steps:
-      - name: Clone the code
+      - name: Checkout repository
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 1  # Minimal history to avoid .git permissions issues
 
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version-file: docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1/go.mod
-
-      - name: Build Sample External Plugin
-        working-directory: docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1
-        run: |
-          mkdir -p ./bin
-          make build
-
-      - name: Move Plugin Binary to Plugin Path
-        run: |
-          # Define the plugin destination for Linux (XDG_CONFIG_HOME path)
-          XDG_CONFIG_HOME="${HOME}/.config"
-          PLUGIN_DEST="$XDG_CONFIG_HOME/kubebuilder/plugins/sampleexternalplugin/v1"
-
-          # Ensure destination exists and move the built binary
-          mkdir -p "$PLUGIN_DEST"
-          mv docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1/bin/sampleexternalplugin "$PLUGIN_DEST/sampleexternalplugin"
-          chmod +x "$PLUGIN_DEST/sampleexternalplugin"  # Ensure the binary is executable
-
-      - name: Build Kubebuilder Binary and Setup Environment
-        env:
-          KUBEBUILDER_ASSETS: $GITHUB_WORKSPACE/bin
-        run: |
-          # Build Kubebuilder Binary
-          export kb_root_dir=$(pwd)
-          go build -o "${kb_root_dir}/bin/kubebuilder" ./cmd
-          chmod +x "${kb_root_dir}/bin/kubebuilder"  # Ensure kubebuilder binary is executable
-          echo "${kb_root_dir}/bin" >> $GITHUB_PATH  # Add to PATH
+          go-version-file: go.mod
 
-      - name: Create Directory, Run Kubebuilder Commands, and Validate Results
-        env:
-          KUBEBUILDER_ASSETS: $GITHUB_WORKSPACE/bin
-        run: |
-          # Create a directory named testplugin for running kubebuilder commands
-          mkdir testplugin
-          cd testplugin
-
-          # Run Kubebuilder commands inside the testplugin directory
-          kubebuilder init --plugins sampleexternalplugin/v1 --domain sample.domain.com
-          kubebuilder create api --plugins sampleexternalplugin/v1 --number=2 --group=example --version=v1alpha1 --kind=ExampleKind
-          kubebuilder create webhook --plugins sampleexternalplugin/v1 --hooked --group=example --version=v1alpha1 --kind=ExampleKind
+      - name: Run tests
+        run: make test-external-plugin
 
-          # Validate generated file contents
-          grep "DOMAIN: sample.domain.com" ./initFile.txt || exit 1
-          grep "NUMBER: 2" ./apiFile.txt || exit 1
-          grep "HOOKED!" ./webhookFile.txt || exit 1

.github/workflows/lint-sample.yml

@@ -12,6 +12,7 @@ jobs:
   lint-samples:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         folder: [
           "testdata/project-v4",
@@ -36,11 +37,10 @@ jobs:
         working-directory: ${{ matrix.folder }}
         run: make lint-config
       - name: Run linter
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
-          version: v1.63.4
+          version: v2.1.6
           working-directory: ${{ matrix.folder }}
-          args: --config .golangci.yml ./...
       - name: Run linter via makefile target
         working-directory: ${{ matrix.folder }}
         run: make lint

.github/workflows/lint.yml

@@ -24,9 +24,9 @@ jobs:
       - name: Check linter configuration
         run: make lint-config
       - name: Run linter
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
-          version: v1.63.4
+          version: v2.1.6
 
   yamllint:
     runs-on: ubuntu-latest

.github/workflows/test-alpha-generate.yml

@@ -35,6 +35,19 @@ jobs:
         run: |
           sed -i 's#go.kubebuilder.io/v4#go.kubebuilder.io/v3#g' testdata/project-v4/PROJECT
 
+      # Validate if help output is working and workaround to
+      # update the PROJECT file in memory to allow upgrade
+      # no longer supported layouts did not break the command options
+      - name: Validate help output for alpha generate
+        run: |
+          if kubebuilder alpha generate --help | grep -q "kubebuilder alpha generate \[flags\]"; then
+            echo "Help output validated"
+          else
+            echo "Help output missing or invalid"
+            exit 1
+          fi    
+
       - name: Run kubebuilder alpha generate
         run: |
-          cd testdata/project-v4 && kubebuilder alpha generate
+          cd testdata/project-v4 && kubebuilder alpha generate
+

.github/workflows/test-e2e-samples.yml

@@ -39,12 +39,9 @@ jobs:
 
       - name: Prepare project-v4
         run: |
+          # Enable [METRICS-WITH-CERTS] by uncommenting the lines in kustomization.yaml
           KUSTOMIZATION_FILE_PATH="testdata/project-v4/config/default/kustomization.yaml"
-          sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
           sed -i '47,49s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment all cert-manager injections
-          sed -i '59,234s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '236,251s/^#//' $KUSTOMIZATION_FILE_PATH
           cd testdata/project-v4/
           go mod tidy
 
@@ -81,17 +78,6 @@ jobs:
 
       - name: Prepare project-v4-with-plugins
         run: |
-          KUSTOMIZATION_FILE_PATH="testdata/project-v4-with-plugins/config/default/kustomization.yaml"
-          sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment only ValidatingWebhookConfiguration
-          # from cert-manager replaces; we are leaving defaulting uncommented
-          # since this sample has no defaulting webhooks
-          sed -i '59,77s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '90,107s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '120,186s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment only --conversion webhooks CA injection
-          sed -i '219,234s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '236,251s/^#//' $KUSTOMIZATION_FILE_PATH
           cd testdata/project-v4-with-plugins/
           go mod tidy
 
@@ -128,13 +114,6 @@ jobs:
 
       - name: Prepare project-v4-multigroup
         run: |
-          KUSTOMIZATION_FILE_PATH="testdata/project-v4-multigroup/config/default/kustomization.yaml"
-          sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment all cert-manager injections for webhooks only
-          sed -i '59,77s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '90,107s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '120,234s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '236,251s/^#//' $KUSTOMIZATION_FILE_PATH
           cd testdata/project-v4-multigroup
           go mod tidy
 

.github/workflows/verify.yml

@@ -13,14 +13,14 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Validate PR Title Format
+        env:
+          TITLE: ${{ github.event.pull_request.title }}
         run: |
-          TITLE="${{ github.event.pull_request.title }}"
-
           if [[ -z "$TITLE" ]]; then
             echo "Error: PR title cannot be empty."
             exit 1
           fi
-          
+
           if ! [[ "$TITLE" =~ ^($'\u26A0'|$'\u2728'|$'\U0001F41B'|$'\U0001F4D6'|$'\U0001F680'|$'\U0001F331') ]]; then
             echo "Error: Invalid PR title format."
             echo "Your PR title must start with one of the following indicators:"
@@ -32,5 +32,5 @@ jobs:
             echo "- Infra/Tests/Other: 🌱 (U+1F331)"
             exit 1
           fi
-          
+
           echo "PR title is valid: '$TITLE'"

.golangci.yml

@@ -1,92 +1,101 @@
+version: "2"
 run:
-  timeout: 5m
   allow-parallel-runners: true
-
-issues:
-  # don't skip warning about doc comments
-  # don't exclude the default set of lint
-  exclude-use-default: false
-  # restore some of the defaults
-  # (fill in the rest as needed)
-  exclude-rules:
-    - linters: [gosec]
-      path: "test/e2e/*"
-    - path: "hack/docs/*"
-      linters:
-        - lll
-        - gosec
-
-linters-settings:
-  govet:
-    enable-all: true
-    disable:
-      - fieldalignment
-      - shadow
-  nolintlint:
-    allow-unused: false
-  revive:
-    rules:
-      # The following rules are recommended https://github.com/mgechev/revive#recommended-configuration
-      - name: blank-imports
-      - name: context-as-argument
-      - name: context-keys-type
-      - name: dot-imports
-        arguments:
-          # dot import should be ONLY allowed for ginkgo testing packages
-          - allowedPackages:
-              - "github.com/onsi/ginkgo/v2"
-              - "github.com/onsi/gomega"
-      - name: error-return
-      - name: error-strings
-      - name: error-naming
-      - name: exported
-      - name: if-return
-      - name: increment-decrement
-      - name: var-naming
-      - name: var-declaration
-      - name: package-comments
-        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
-      - name: range
-      - name: receiver-naming
-      - name: time-naming
-      - name: unexported-return
-      - name: indent-error-flow
-      - name: errorf
-      - name: empty-block
-      - name: superfluous-else
-      - name: unused-parameter
-      - name: unreachable-code
-      - name: redefines-builtin-id
-      #
-      # Rules in addition to the recommended configuration above.
-      #
-      - name: bool-literal-in-expr
-      - name: constant-logical-expr
-      - name: comment-spacings
-
 linters:
-  disable-all: true
+  default: none
   enable:
+    - asciicheck
+    - bidichk
+    - copyloopvar
     - dupl
     - errcheck
-    - copyloopvar
     - ginkgolinter
     - goconst
     - gocyclo
-    - gofmt
-    - goimports
-    - gosimple
     - govet
     - ineffassign
     - lll
     - misspell
-    - nolintlint
     - nakedret
+    - nolintlint
     - prealloc
     - revive
     - staticcheck
-    - typecheck
     - unconvert
     - unparam
     - unused
-
+    - wrapcheck
+    - whitespace
+  settings:
+    ginkgolinter:
+      forbid-focus-container: true
+      forbid-spec-pollution: true
+    govet:
+      disable:
+        - fieldalignment
+      enable-all: true
+    nolintlint:
+      allow-unused: false
+    revive:
+      rules:
+        - name: blank-imports
+        - name: context-as-argument
+        - name: context-keys-type
+        - name: dot-imports
+          arguments:
+            - allowedPackages:
+                - github.com/onsi/ginkgo/v2
+                - github.com/onsi/gomega
+        - name: error-return
+        - name: error-strings
+        - name: error-naming
+        - name: exported
+        - name: if-return
+        - name: import-shadowing
+        - name: increment-decrement
+        - name: var-naming
+        - name: var-declaration
+        - name: package-comments
+          disabled: true
+        - name: range
+        - name: receiver-naming
+        - name: time-naming
+        - name: unexported-return
+        - name: indent-error-flow
+        - name: errorf
+        - name: empty-block
+        - name: superfluous-else
+        - name: unused-parameter
+        - name: unreachable-code
+        - name: redefines-builtin-id
+        - name: bool-literal-in-expr
+        - name: constant-logical-expr
+        - name: comment-spacings
+  exclusions:
+    generated: lax
+    rules:
+      - linters:
+          - gosec
+        path: test/e2e/*
+      - linters:
+          - gosec
+          - lll
+        path: hack/docs/*
+      - linters:
+          - revive
+        text: 'should have comment or be unexported'
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gofmt
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

CONTRIBUTING.md

@@ -80,9 +80,8 @@ To manually setup run:
 ```shell
 # To generate an Kubebuilder local binary with your changes
 make install
-# To create the cluster and configure a CNI which supports NetworkPolicy
+# To create the cluster
 kind create cluster --config ./test/e2e/kind-config.yaml
-kubectl apply -f https://docs.projectcalico.org/manifests/calico.yaml
 ```
 
 Now, you can for example, run in debug mode the `test/e2e/v4/e2e_suite_test.go`: