Merge pull request #2952 from kubernetes-sigs/release-3.7

📖 Update docs with release 3.7.0

Author: k8s-ci-robot

.github/workflows/apidiff.yml

@@ -37,9 +37,9 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v3
         with:
-          go-version: "1.18"
+          go-version: "1.19"
       - name: Execute go-apidiff
-        uses: joelanford/go-apidiff@v0.2.0
+        uses: joelanford/go-apidiff@v0.4.0
         with:
           compare-imports: true
           print-compatible: true

.github/workflows/lint.yml

@@ -30,12 +30,16 @@ jobs:
     # 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'
     steps:
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Run linter
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.45.2 # Always uses the latest patch version.
+          version: v1.49 # Always uses the latest patch version.
           only-new-issues: true # Show only new issues if it's a pull request
       - name: Report failure
         uses: nashmaniac/[email protected]

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: release
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Fetch all tags
+        run: git fetch --force --tags
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '~1.19'
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v2
+        with:
+          version: v1.11.2
+          args: release -f ./build/.goreleaser.yml --rm-dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload assets
+        uses: actions/upload-artifact@v3
+        with:
+          name: kubebuilder
+          path: dist/*
+          if-no-files-found: error

.github/workflows/testdata.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v3
         with:
-          go-version: '1.18'
+          go-version: '1.19'
       - name: Remove pre-installed kustomize
         # This step is needed as the following one tries to remove
         # kustomize for each test but has no permission to do so

.github/workflows/unit-tests.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v3
         with:
-          go-version: "1.18"
+          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
@@ -71,7 +71,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v3
         with:
-          go-version: "1.18"
+          go-version: "1.19"
       - name: Generate the coverage output
         run: make test-coverage
       - name: Send the coverage output

.golangci.yml

@@ -19,7 +19,6 @@ linters-settings:
 linters:
   disable-all: true
   enable:
-    - deadcode
     - dupl
     - errcheck
     - exportloopref
@@ -37,12 +36,10 @@ linters:
     - prealloc
     - revive
     - staticcheck
-    - structcheck
     - typecheck
     - unconvert
     - unparam
     - unused
-    - varcheck
 
 run:
   deadline: 5m

CONTRIBUTING.md

@@ -43,27 +43,28 @@ $ git clone [email protected]:<user>/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebu
 
 1. Run the script `make generate` to update/generate the mock data used in the e2e test in `$GOPATH/src/sigs.k8s.io/kubebuilder/testdata/`
 1. Run `make test-unit test-e2e-local`
-  - e2e tests use [`kind`][kind] and [`setup-envtest`][setup-envtest]. If you want to bring your own binaries, place them in `$(go env GOPATH)/bin`.
+
+- e2e tests use [`kind`][kind] and [`setup-envtest`][setup-envtest]. If you want to bring your own binaries, place them in `$(go env GOPATH)/bin`.
 
 **IMPORTANT:** The `make generate` is very helpful. By using it, you can check if good part of the commands still working successfully after the changes. Also, note that its usage is a pre-requirement to submit a PR.
 
 Following the targets that can be used to test your changes locally.
 
-|   Command	|   Description	|  Is called in the CI?  	|
-|---	|---	|---	|
-| make test-unit |  Runs go tests | no   	|
-| make test| Runs tests in shell (`./test.sh`)	|  yes 	|
-| make lint |  Run [golangci][golangci] lint checks | yes   |
-| make lint-fix |   Run [golangci][golangci] to automatically perform fixes | no   |
-| make test-coverage |  Run coveralls to check the % of code covered by tests | yes   |
-| make check-testdata |  Checks if the testdata dir is updated with the latest changes | yes   |
-| make test-e2e-local |  Runs the CI e2e tests locally | no   |
+| Command             | Description                                                   | Is called in the CI? |
+| ------------------- | ------------------------------------------------------------- | -------------------- |
+| make test-unit      | Runs go tests                                                 | no                   |
+| make test           | Runs tests in shell (`./test.sh`)                             | yes                  |
+| make lint           | Run [golangci][golangci] lint checks                          | yes                  |
+| make lint-fix       | Run [golangci][golangci] to automatically perform fixes       | no                   |
+| make test-coverage  | Run coveralls to check the % of code covered by tests         | yes                  |
+| make check-testdata | Checks if the testdata dir is updated with the latest changes | yes                  |
+| make test-e2e-local | Runs the CI e2e tests locally                                 | no                   |
 
 **NOTE** To use the `make lint` is required to install `golangci-lint` locally. More info: https://github.com/golangci/golangci-lint#install
 
 ## PR Process
 
-See [VERSIONING.md](VERSIONING.md) for a full description.  TL;DR:
+See [VERSIONING.md](VERSIONING.md) for a full description. TL;DR:
 
 Every PR should be annotated with an icon indicating whether it's
 a:
@@ -90,8 +91,9 @@ separately.
 ## Where the CI Tests are configured
 
 1. See the [action files](.github/workflows) to check its tests, and the scripts used on it.
-1. Note that the prow tests used in the CI are configured in [kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml).
-1. Check that all scripts used by the CI are defined in the project.
+2. Note that the prow tests used in the CI are configured in [kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml).
+3. Check that all scripts used by the CI are defined in the project.
+4. Notice that our policy to test the project is to run against k8s version N-2. So that the old version should be removed when there is a new k8s version available.
 
 ## How to contribute to docs
 
@@ -115,19 +117,20 @@ Check the CI job after to do the Pull Request and then, click on in the `Details
 Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
 
 You can reach the maintainers of this project at:
+
 - [Slack](http://slack.k8s.io/)
 - [Mailing List](https://groups.google.com/forum/#!forum/kubebuilder)
 
 ## Becoming a reviewer or approver
 
 Contributors may eventually become official reviewers or approvers in
-Kubebuilder and the related repositories.  See
+Kubebuilder and the related repositories. See
 [CONTRIBUTING-ROLES.md](docs/CONTRIBUTING-ROLES.md) for more information.
 
 ## Code of conduct
 
 Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
 
-[golangci]:https://github.com/golangci/golangci-lint
-[kind]:https://kind.sigs.k8s.io/#installation-and-usage
-[setup-envtest]:https://book.kubebuilder.io/reference/envtest
+[golangci]: https://github.com/golangci/golangci-lint
+[kind]: https://kind.sigs.k8s.io/#installation-and-usage
+[setup-envtest]: https://book.kubebuilder.io/reference/envtest

Makefile

@@ -83,7 +83,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.45.2 ;\
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) v1.49.0 ;\
 	}
 
 .PHONY: apidiff

OWNERS_ALIASES

@@ -9,11 +9,12 @@ aliases:
 
   # 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:
-    - jmrodri
     - joelanford
     - rashmigottipati
     - everettraven

README.md

@@ -38,6 +38,11 @@ See the [Getting Started](https://book.kubebuilder.io/quick-start.html) document
 
 ![Quick Start](docs/gif/kb-demo.v2.0.1.svg)
 
+Also, ensure that you check out the [Deploy Image](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html) 
+Plugin. This plugin allows users to scaffold API/Controllers to deploy and manage an 
+Operand (image) on the cluster following the guidelines and best practices. It abstracts the 
+complexities of achieving this goal while allowing users to customize the generated code.
+
 ## Documentation
 
 Check out the Kubebuilder [book](https://book.kubebuilder.io).