📖 Add Good Practices documentation

.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.6.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.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
@@ -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

@@ -19,7 +19,7 @@ jobs:
         with:
           go-version: '~1.19'
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v3
+        uses: goreleaser/goreleaser-action@v4
         with:
           version: v1.11.2
           args: release -f ./build/.goreleaser.yml --rm-dist

.github/workflows/testdata.yml

@@ -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/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 }}

.gitignore

@@ -4,6 +4,9 @@ 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

@@ -139,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

@@ -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,27 +63,39 @@ 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 ## 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.51.2 ;\
 	}
 
 .PHONY: apidiff
@@ -92,7 +104,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 +151,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,18 +6,19 @@ 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)
   kubebuilder-reviewers:
     - 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
 
@@ -86,13 +64,8 @@ The releases occur in an account in the Google Cloud (See [here](https://console
 
 ### To build the Kubebuilder CLI binaries:
 
-A trigger `build-kb-release` is configured to call [build/cloudbuild.yaml](build/cloudbuild.yaml).
-This trigger will be executed when any new tag be published. 
-The tags must be built from the release branch (Currently, `release-3`).
-
-Also, we have a trigger to generate snapshots builds from the master branch.
-This trigger will call [build/cloudbuild_snapshot.yaml](build/cloudbuild_snapshot.yaml)
-when any change needs to be performed on master.
+A trigger GitHub action [release](.github/workflows/release.yml) is trigged when a new tag is pushed.
+This action will caall the job [./build/.goreleaser.yml](./build/.goreleaser.yml).
 
 ### To build the Kubebuilder-tools: (Artifacts required to use ENV TEST)
 
@@ -146,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.25.0
+      - KUBERNETES_VERSION=1.26.1
       - CGO_ENABLED=0
 
 # Only binaries of the form "kubebuilder_${goos}_${goarch}" will be released.