📖 Update Book-V3 with latest release v3.10.0 (#3342)

Update the book-v3 with all changes made up of release v3.10.0.
In this PR we need to solve conflicts and ensure that this branch is == the latest version of the master branch/release-v3.10 used to do the release.

.github/workflows/apidiff.yml

@@ -6,40 +6,22 @@ on:
   pull_request:
 
 jobs:
-  check_docs_only:
-    name: check_docs_only
-    runs-on: ubuntu-18.04
-    outputs:
-      skip: ${{ steps.check_docs_only.outputs.skip }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - id: check_docs_only
-        # Since PR's are squashed prior to merging to the branch checked out (default branch),
-        # HEAD^ will resolve to the previous point in history.
-        run: |
-          REF="HEAD^"
-          [[ -z "${{ github.base_ref }}" ]] || REF=$(git show-ref ${{ github.base_ref }} | head -1 | cut -d' ' -f2)
-          echo "::set-output name=skip::$(test/check-docs-only.sh $REF)"
-
   go-apidiff:
     name: Verify API differences
     runs-on: ubuntu-latest
-    needs: check_docs_only
     # Pull requests from different repository only trigger this checks
-    if: (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Clone the code
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: "1.19"
       - name: Execute go-apidiff
-        uses: joelanford/go-apidiff@v0.5.0
+        uses: joelanford/go-apidiff@v0.6.0
         with:
           compare-imports: true
           print-compatible: true

.github/workflows/lint.yml

@@ -6,40 +6,22 @@ on:
   pull_request:
 
 jobs:
-  check_docs_only:
-    name: check_docs_only
-    runs-on: ubuntu-18.04
-    outputs:
-      skip: ${{ steps.check_docs_only.outputs.skip }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - id: check_docs_only
-        # Since PR's are squashed prior to merging to the branch checked out (default branch),
-        # HEAD^ will resolve to the previous point in history.
-        run: |
-          REF="HEAD^"
-          [[ -z "${{ github.base_ref }}" ]] || REF=$(git show-ref ${{ github.base_ref }} | head -1 | cut -d' ' -f2)
-          echo "::set-output name=skip::$(test/check-docs-only.sh $REF)"
-
   lint:
     name: golangci-lint
     runs-on: ubuntu-latest
-    needs: check_docs_only
     # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
-    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: 1.19
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Run linter
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.50
+          version: v1.51
           only-new-issues: true # Show only new issues if it's a pull request
       - name: Report failure
         uses: nashmaniac/create-issue-action@v1.1
@@ -56,4 +38,4 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Run yamllint make target
-        run: make yamllint
+        run: make yamllint

.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Fetch all tags
         run: git fetch --force --tags
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: '~1.19'
       - name: Run GoReleaser

.github/workflows/testdata.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: '1.19'
       - name: Remove pre-installed kustomize
@@ -25,6 +25,8 @@ jobs:
         run: sudo rm -f /usr/local/bin/kustomize
       - name: Verify testdata directory
         run: make check-testdata
+      - name: Verify docs update
+        run: make check-docs
       - name: Report failure
         uses: nashmaniac/create-issue-action@v1.1
         # Only report failures of pushes (PRs have are visible through the Checks section) to the default branch

.github/workflows/unit-tests-legacy.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           # the go/v2 cannot be updated and is scaffold with golang 1.13
           # (version used by its dep version of the controller-runtime)

.github/workflows/unit-tests.yml

@@ -6,23 +6,6 @@ on:
   pull_request:
 
 jobs:
-  check_docs_only:
-    name: check_docs_only
-    runs-on: ubuntu-18.04
-    outputs:
-      skip: ${{ steps.check_docs_only.outputs.skip }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - id: check_docs_only
-        # Since PR's are squashed prior to merging to the branch checked out (default branch),
-        # HEAD^ will resolve to the previous point in history.
-        run: |
-          REF="HEAD^"
-          [[ -z "${{ github.base_ref }}" ]] || REF=$(git show-ref ${{ github.base_ref }} | head -1 | cut -d' ' -f2)
-          echo "::set-output name=skip::$(test/check-docs-only.sh $REF)"
-
   test:
     name: ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
@@ -31,14 +14,13 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-    needs: check_docs_only
     # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
-    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: "1.19"
       # This step is needed as the following one tries to remove
@@ -61,15 +43,14 @@ jobs:
     name: Code coverage
     needs:
       - test
-      - check_docs_only
     runs-on: ubuntu-latest
     # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
-    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: "1.19"
       - name: Generate the coverage output

.github/workflows/verify.yml

@@ -13,6 +13,6 @@ jobs:
     steps:
     - name: Verifier action
       id: verifier
-      uses: kubernetes-sigs/kubebuilder-release-tools@v0.2.0
+      uses: kubernetes-sigs/kubebuilder-release-tools@v0.3.0
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}

Makefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-#  Copyright 2019 The Kubernetes Authors.
+#  Copyright 2023 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.
@@ -63,14 +63,22 @@ install: build ## Build and install the binary with the current source code. Use
 ##@ Development
 
 .PHONY: generate
-generate: generate-testdata ## Update/generate all mock data. You should run this commands to update the mock data after your changes.
+generate: generate-testdata generate-docs ## Update/generate all mock data. You should run this commands to update the mock data after your changes.
 	go mod tidy
 
 .PHONY: generate-testdata
 generate-testdata: ## Update/generate the testdata in $GOPATH/src/sigs.k8s.io/kubebuilder
 	rm -rf testdata/
 	./test/testdata/generate.sh
 
+.PHONY: generate-docs
+generate-docs: ## Update/generate the docs in $GOPATH/src/sigs.k8s.io/kubebuilder
+	go run hack/docs/generate_samples.go
+
+.PHONY: check-docs
+check-docs: ## Run the script to ensure that the docs are updated
+	./hack/docs/check.sh
+
 .PHONY: lint
 lint: golangci-lint yamllint ## Run golangci-lint linter & yamllint
 	$(GOLANGCI_LINT) run
@@ -87,7 +95,7 @@ GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint
 golangci-lint:
 	@[ -f $(GOLANGCI_LINT) ] || { \
 	set -e ;\
-	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) v1.50.1 ;\
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) v1.51.2 ;\
 	}
 
 .PHONY: apidiff

OWNERS_ALIASES

@@ -18,6 +18,7 @@ aliases:
     - joelanford
     - rashmigottipati
     - everettraven
+    - Kavinjsir
 
   # folks who may have context on ancient history,
   # but are no longer directly involved

README.md

@@ -2,6 +2,7 @@
 [![Unit tests](https://github.com/kubernetes-sigs/kubebuilder/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/kubernetes-sigs/kubebuilder/actions/workflows/unit-tests.yml)
 [![Go Report Card](https://goreportcard.com/badge/sigs.k8s.io/kubebuilder)](https://goreportcard.com/report/sigs.k8s.io/kubebuilder)
 [![Coverage Status](https://coveralls.io/repos/github/kubernetes-sigs/kubebuilder/badge.svg?branch=master)](https://coveralls.io/github/kubernetes-sigs/kubebuilder?branch=master)
+[![Latest release](https://badgen.net/github/release/kubernetes-sigs/kubebuilder)](https://github.com/kubernetes-sigs/kubebuilder/lreleases)
 
 ## Kubebuilder
 
@@ -126,16 +127,7 @@ supporting Windows are welcome.
 
 ### Apple Silicon
 
-Apple Silicon (`darwin/arm64`) is supported using the `go/v4-alpha` plugin which provides support for this platform. 
-
-```bash
-kubebuilder init --domain my.domain --repo my.domain/guestbook --plugins=go/v4-alpha
-```
-
-**Note**: The `go/v4-alpha` plugin is an unstable version and can have breaking changes in future releases. The previous kustomize 
-version (`v3.Y.Z`) used in the `go/v3` has no available binaries for this 
-platform [kubernetes-sigs/kustomize/issues/4612](https://github.com/kubernetes-sigs/kustomize/issues/4612)
-Because of this, we cannot support this `darwin/arm64` on the stable scaffold done  by default with the Kubebuilder with the `go/v3` plugin.
+Apple Silicon (`darwin/arm64`) support begins with the `go/v4` plugin.
 
 ## Community Meetings
 

RELEASE.md

@@ -50,28 +50,6 @@ For more info, see the release page: https://github.com/kubernetes-sigs/kubebuil
 
 2. Announce the new release via email is sent to `kubebuilder@googlegroups.com` with the subject `[ANNOUNCE] Kubebuilder $VERSION is released`
 
-## What to do if things goes wrong? How to release from my local env as a workaround?
-
-As a workaround we can release from locally by: 
-
-PS.: _This workaround uses the google cloud. Note that we move the binary CLI release from google cloud to use Github Actions instead_
-
-1. Download google container builder: https://github.com/GoogleCloudPlatform/cloud-build-local
-2. Verify that you can use the cloud-build-local CLI tool
-3. Ensure that you are locally in the branch created for the release (`release-<MAJOR.MINOR>`)
-4. Ensure that it has no changes in the code source ( `git status`)
-5. Create the directory `cloudbuild` (`mkdir cloudbuild`)
-6. Then, update the file `build/cloudbuild_local.yaml` with:
-
-The following change is required for Goreleaser be able to add the binaries in the release page.
-
-```sh
-env: ["SNAPSHOT=1","GITHUB_TOKEN=your github token with access in the repo"]
-```
-**NOTE** You can create a token [here](https://github.com/settings/tokens/new).
-
-7. Then, update the file `build/build_kubebuilder.sh` to remove the flag `--snapshot` (Otherwise, the binaries will be built with snapshot git commit hash instead of the tag version)
-8. Run the command to trigger the release `$ cloud-build-local --config=build/cloudbuild_local.yaml --dryrun=false --write-workspace=./cloudbuild .`
 
 ## HEAD releases
 
@@ -141,4 +119,4 @@ However, the image should still be built and maintained since other projects und
 
 [kubebuilder-release-tools]: https://github.com/kubernetes-sigs/kubebuilder-release-tools
 [release-notes-generation]: https://github.com/kubernetes-sigs/kubebuilder-release-tools/blob/master/README.md#release-notes-generation
-[release-process]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/VERSIONING.md#releasing 
+[release-process]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/VERSIONING.md#releasing 

build/.goreleaser.yml

@@ -44,7 +44,7 @@ builds:
       - darwin_amd64
       - darwin_arm64
     env:
-      - KUBERNETES_VERSION=1.26.0
+      - KUBERNETES_VERSION=1.26.1
       - CGO_ENABLED=0
 
 # Only binaries of the form "kubebuilder_${goos}_${goarch}" will be released.

cmd/main.go

@@ -25,10 +25,9 @@ import (
 	cfgv2 "sigs.k8s.io/kubebuilder/v3/pkg/config/v2"
 	cfgv3 "sigs.k8s.io/kubebuilder/v3/pkg/config/v3"
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
-	"sigs.k8s.io/kubebuilder/v3/pkg/model/stage"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 	kustomizecommonv1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/common/kustomize/v1"
-	kustomizecommonv2alpha "sigs.k8s.io/kubebuilder/v3/pkg/plugins/common/kustomize/v2-alpha"
+	kustomizecommonv2alpha "sigs.k8s.io/kubebuilder/v3/pkg/plugins/common/kustomize/v2"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang"
 	declarativev1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/declarative/v1"
 	deployimagev1alpha1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/deploy-image/v1alpha1"
@@ -40,13 +39,22 @@ import (
 
 func main() {
 
+	const deprecateMessageGoV3Bundle = "This version is deprecated." +
+		"The `go/v3` cannot scaffold projects using kustomize versions v4x+" +
+		" and cannot fully support Kubernetes 1.25+." +
+		"It is recommended to upgrade your project to the latest versions available (go/v4)." +
+		"Please, check the migration guide to learn how to upgrade your project"
+
 	// Bundle plugin which built the golang projects scaffold by Kubebuilder go/v3
 	gov3Bundle, _ := plugin.NewBundle(golang.DefaultNameQualifier, plugin.Version{Number: 3},
+		deprecateMessageGoV3Bundle,
 		kustomizecommonv1.Plugin{},
 		golangv3.Plugin{},
 	)
+
 	// Bundle plugin which built the golang projects scaffold by Kubebuilder go/v4 with kustomize alpha-v2
-	gov4Bundle, _ := plugin.NewBundle(golang.DefaultNameQualifier, plugin.Version{Number: 4, Stage: stage.Alpha},
+	gov4Bundle, _ := plugin.NewBundle(golang.DefaultNameQualifier, plugin.Version{Number: 4},
+		"",
 		kustomizecommonv2alpha.Plugin{},
 		golangv4.Plugin{},
 	)
@@ -76,7 +84,7 @@ func main() {
 		),
 		cli.WithPlugins(externalPlugins...),
 		cli.WithDefaultPlugins(cfgv2.Version, golangv2.Plugin{}),
-		cli.WithDefaultPlugins(cfgv3.Version, gov3Bundle),
+		cli.WithDefaultPlugins(cfgv3.Version, gov4Bundle),
 		cli.WithDefaultProjectVersion(cfgv3.Version),
 		cli.WithCompletion(),
 	)

designs/code-generate-image-plugin.md

@@ -1,15 +1,6 @@
----
-title: Neat-Enhancement-Idea
-authors:
-  - "@camilamacedo86"
-reviewers:
-  - TBD
-approvers:
-  - TBD
-creation-date: 2020-11-09
-last-updated: 2021-02-14
-status: implementable
----
+| Authors       | Creation Date | Status      | Extra |
+|---------------|---------------|-------------|---|
+| @camilamacedo86 | 2021-02-14 | Implemented | [deploy-image-plugin-v1-alpha](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html) |
 
 # New Plugin (`deploy-image.go.kubebuilder.io/v1beta1`) to generate code
 

designs/crd_version_conversion.md

@@ -1,7 +1,8 @@
-# API Versioning in Kubebuilder
+| Authors       | Creation Date | Status      | Extra |
+|---------------|---------------|-------------|-------|
+| @droot | 01/30/2019| implementable | -     |
 
-Authors: @droot 
-Last Updated on: 01/30/2019
+# API Versioning in Kubebuilder
 
 This document describes high level design and workflow for supporting multiple versions in an API built using Kubebuilder. Multi-version support was added as an alpha feature in kubernetes project in 1.13 release. Here are links to some recommended reading material.