📖 Update docs for release 3.8.0

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -36,7 +36,7 @@ body:
       <summary>Code & details examples</summary>
 
       `````markdown
-      Some code code written in Go:
+      Some code written in Go:
 
       ```go
       type Manager struct {

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -36,7 +36,7 @@ body:
       <summary>Code & details examples</summary>
 
       `````markdown
-      Some code code written in Go:
+      Some code written in Go:
 
       ```go
       type Manager struct {
@@ -75,7 +75,7 @@ body:
 
       Does it require a particular Kubernetes version?
 
-      Is there currently another isssue associated with this (use github syntax
+      Is there currently another issue associated with this (use github syntax
       like `#xyz` to link to it)?
   validations: {required: true}
 

.github/dependabot.yml

@@ -0,0 +1,49 @@
+# 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:
+
+  # 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"
+    labels:
+      - "ok-to-test"
+
+  # Maintain dependencies for dockerfile in the branches
+  - package-ecosystem: docker
+    directory: "/build/thirdparty/darwin"
+    target-branch: "tools-releases"
+    schedule:
+      interval: daily
+  - package-ecosystem: docker
+    directory: "/build/thirdparty/linux"
+    target-branch: "tools-releases"
+    schedule:
+      interval: "weekly"
+
+  # Maintain dependencies for dockerfile scaffold in the projects
+  - package-ecosystem: docker
+    directory: "testdata/project-v3"
+    schedule:
+      interval: daily
+  - package-ecosystem: docker
+    directory: "testdata/project-v4"
+    schedule:
+      interval: "weekly"

.github/workflows/apidiff.yml

@@ -39,7 +39,7 @@ jobs:
         with:
           go-version: "1.19"
       - name: Execute go-apidiff
-        uses: joelanford/go-apidiff@v0.4.0
+        uses: joelanford/go-apidiff@v0.5.0
         with:
           compare-imports: true
           print-compatible: true

.github/workflows/lint.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Run linter
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.49 # Always uses the latest patch version.
+          version: v1.50
           only-new-issues: true # Show only new issues if it's a pull request
       - name: Report failure
         uses: nashmaniac/[email protected]
@@ -50,3 +50,10 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           labels: kind/bug
           body: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run yamllint make target
+        run: make yamllint

.github/workflows/release.yml

@@ -9,17 +9,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Fetch all tags
         run: git fetch --force --tags
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: '~1.19'
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2
+        uses: goreleaser/goreleaser-action@v3
         with:
           version: v1.11.2
           args: release -f ./build/.goreleaser.yml --rm-dist

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

@@ -32,7 +32,7 @@ jobs:
           # Therefore, we probably will deprecate go/v2 soon since we cannot upgrade it
           # to use the versions of controller-runtime > v0.9
           # and controller-tools > v0.6 as k8s > 1.21 then it might not be valid we spend effort on this fix
-          go-version: "1.17"
+          go-version: "1.19"
       # This step is needed as the following one tries to remove
       # kustomize for each test but has no permission to do so
       - name: Remove pre-installed kustomize

.gitignore

@@ -1,9 +1,12 @@
 .idea/
 .vscode/
-
+WORKSPACE
 # don't check in the build output of the book
 docs/book/book/
 
+# ignore auto-generated dir by `mdbook serve`
+docs/book/src/docs
+
 # Editor temp files
 *~
 \#*#
@@ -22,3 +25,4 @@ docs/book/book/
 # skip testdata go.sum, since it may have
 # different result depending on go version
 /testdata/**/go.sum
+/docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1/bin

.golangci.yml

@@ -1,3 +1,7 @@
+run:
+  deadline: 5m
+  allow-parallel-runners: true
+
 issues:
   # don't skip warning about doc comments
   # don't exclude the default set of lint
@@ -13,8 +17,41 @@ linters-settings:
     enable=fieldalignment: true
   revive:
     rules:
-    - name: if-return
-      disabled: true
+      # 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
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: exported
+        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - name: if-return
+        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - name: increment-decrement
+      - name: var-naming
+        disabled: true   # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - 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
+        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - 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
 
 linters:
   disable-all: true
@@ -40,6 +77,3 @@ linters:
     - unconvert
     - unparam
     - unused
-
-run:
-  deadline: 5m

CONTRIBUTING.md

@@ -62,6 +62,63 @@ Following the targets that can be used to test your changes locally.
 
 **NOTE** To use the `make lint` is required to install `golangci-lint` locally. More info: https://github.com/golangci/golangci-lint#install
 
+### Test Plugin
+
+If your intended PR creates a new plugin, make sure the PR also provides test cases. Testing should include:
+
+1. `e2e tests` to validate the behavior of the proposed plugin.
+2. `sample projects` to verify the scaffolded output from the plugin.
+
+#### 1. Plugin E2E Tests
+
+All the plugins provided by Kubebuilder should be validated through `e2e-tests` across multiple platforms.
+
+Current Kubebuilder provides the testing framework that includes testing code based on [ginkgo](https://github.com/onsi/ginkgo), [Github Actions](https://github.com/Kavinjsir/kubebuilder/blob/docs%2Ftest-plugin/.github/workflows/testdata.yml) for unit tests, and multiple env tests driven by [test-infra](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml).
+
+To fully test the proposed plugin:
+
+1. Create a new package(folder) under `test/e2e/<your-plugin>`.
+2. Create [e2e_suite_test.go](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/v4/e2e_suite_test.go), which imports the necessary testing framework.
+3. Create `generate_test.go` ([ref](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/v4/generate_test.go)). That should:
+   - Introduce/Receive a `TextContext` instance
+   - Trigger the plugin's bound subcommands. See [Init](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L213), [CreateAPI](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.6.0/test/e2e/utils/test_context.go#L222)
+   - Use [PluginUtil](https://pkg.go.dev/sigs.k8s.io/kubebuilder/v3/pkg/plugin/util) to verify the scaffolded outputs. See [InsertCode](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/pkg/plugin/util/util.go#L67), [ReplaceInFile](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.6.0/pkg/plugin/util/util.go#L196), [UncommendCode](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.6.0/pkg/plugin/util/util.go#L86)
+4. Create `plugin_cluster_test.go` ([ref](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/v4/plugin_cluster_test.go)). That should:
+
+   - 4.1. Setup testing environment, e.g:
+
+     - Cleanup environment, create temp dir. See [Prepare](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L97)
+     - If your test will cover the provided features then, ensure that you install prerequisites CRDs: See [InstallCertManager](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L138), [InstallPrometheusManager](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.6.0/test/e2e/utils/test_context.go#L171)
+
+   - 4.2. Run the function from `generate_test.go`.
+
+   - 4.3. Further make sure the scaffolded output works, e.g:
+
+     - Execute commands in your `Makefile`. See [Make](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L240)
+     - Temporary load image of the testing controller. See [LoadImageToKindCluster](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L283)
+     - Call Kubectl to validate running resources. See [utils.Kubectl](https://pkg.go.dev/sigs.k8s.io/kubebuilder/v3/test/e2e/utils#Kubectl)
+
+   - 4.4. Delete temporary resources after testing exited, e.g:
+     - Uninstall prerequisites CRDs: See [UninstallPrometheusOperManager](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L183)
+     - Delete temp dir. See [Destroy](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/utils/test_context.go#L255)
+
+5. Add the command in [test/e2e/plugin](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/e2e/setup.sh#L65) to run your testing code:
+
+```shell
+go test $(dirname "$0")/<your-plugin-test-folder> $flags -timeout 30m
+```
+
+#### 2. Sample Projects from the Plugin
+
+It is also necessary to test consistency of the proposed plugin across different env and the integration with other plugins.
+
+This is performed by generating sample projects based on the plugins. The CI workflow defined in Github Action would validate the availability and the consistency.
+
+See:
+
+- [test/testdata/generated.sh](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/test/testdata/generate.sh#L144)
+- [make generate](https://github.com/kubernetes-sigs/kubebuilder/blob/v3.7.0/Makefile#L70)
+
 ## PR Process
 
 See [VERSIONING.md](VERSIONING.md) for a full description. TL;DR:
@@ -82,6 +139,13 @@ changes, which don't deserve a release note. Please don't abuse it.
 You can also use the equivalent emoji directly, since GitHub doesn't
 render the `:xyz:` aliases in PR titles.
 
+If the PR is "plugin" scoped, you may also append the responding plugin names in the prefix.
+[For instance](https://github.com/kubernetes-sigs/kubebuilder/commit/0b36d0c4021bbf52f29d5a990157466761ec180c):
+
+```
+🐛 (kustomize/v2-alpha): Fix typo issue in the labels added to the manifests
+```
+
 Individual commits should not be tagged separately, but will generally be
 assumed to match the PR. For instance, if you have a bugfix in with
 a breaking change, it's generally encouraged to submit the bugfix

Makefile

@@ -72,18 +72,22 @@ generate-testdata: ## Update/generate the testdata in $GOPATH/src/sigs.k8s.io/ku
 	./test/testdata/generate.sh
 
 .PHONY: lint
-lint: golangci-lint ## Run golangci-lint linter
+lint: golangci-lint yamllint ## Run golangci-lint linter & yamllint
 	$(GOLANGCI_LINT) run
 
 .PHONY: lint-fix
 lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 	$(GOLANGCI_LINT) run --fix
 
+.PHONY: yamllint
+yamllint:
+	@docker run --rm $$(tty -s && echo "-it" || echo) -v $(PWD):/data cytopia/yamllint:latest testdata -d "{extends: relaxed, rules: {line-length: {max: 120}}}" --no-warnings
+
 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.49.0 ;\
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) v1.50.1 ;\
 	}
 
 .PHONY: apidiff
@@ -92,7 +96,7 @@ apidiff: go-apidiff ## Run the go-apidiff to verify any API differences compared
 
 .PHONY: go-apidiff
 go-apidiff:
-	go install github.com/joelanford/go-apidiff@v0.4.0
+	go install github.com/joelanford/go-apidiff@v0.5.0
 
 ##@ Tests
 
@@ -139,6 +143,8 @@ test-e2e-ci: ## Run the end-to-end tests (used in the CI)`
 .PHONY: test-book
 test-book: ## Run the cronjob tutorial's unit tests to make sure we don't break it
 	cd ./docs/book/src/cronjob-tutorial/testdata/project && make test
+	cd ./docs/book/src/component-config-tutorial/testdata/project && make test
+	cd ./docs/book/src/multiversion-tutorial/testdata/project && make test
 
 .PHONY: test-license
 test-license:  ## Run the license check

OWNERS_ALIASES

@@ -6,11 +6,11 @@ aliases:
   kubebuilder-admins:
     - pwittrock
     - camilamacedo86
+    - jmrodri
+    - varshaprasad96
 
   # non-admin folks who can approve any PRs in the repo
   kubebuilder-approvers:
-    - jmrodri
-    - varshaprasad96
 
   # folks who can review and LGTM any PRs in the repo (doesn't include
   # approvers & admins -- those count too via the OWNERS file)

RELEASE.md

@@ -7,7 +7,7 @@ to create a new branch. Instead, you will just need to ensure that all major fix
 `release-MAJOR.MINOR` branch. To know more about versioning check https://semver.org/.
 
 **Note:** Before `3.5.*` release this project was released based on `MAJOR`. A change to the
-the process was done to ensure that we have an aligned process under the org (similar to `controller-runtime` and
+process was done to ensure that we have an aligned process under the org (similar to `controller-runtime` and
 `controller-tools`) and to make it easier to produce patch releases.
 
 ## How to do a release

build/.goreleaser.yml

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