Merge pull request #3829 from kubernetes-sigs/master

🌱 Update release-3.14 branch with the latest changes due PATCH release 3.14.1

.github/dependabot.yml

@@ -22,6 +22,8 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    commit-message:
+      prefix: ":seedling:"
     labels:
       - "ok-to-test"
 
@@ -31,26 +33,36 @@ updates:
     target-branch: "tools-releases"
     schedule:
       interval: daily
+    commit-message:
+      prefix: ":seedling:"
   - package-ecosystem: docker
     directory: "/build/thirdparty/linux"
     target-branch: "tools-releases"
     schedule:
       interval: "weekly"
+    commit-message:
+      prefix: ":seedling:"
 
   # Maintain dependencies for dockerfile scaffold in the projects
   - package-ecosystem: docker
     directory: "testdata/project-v3"
     schedule:
       interval: daily
+    commit-message:
+      prefix: ":seedling:"
   - package-ecosystem: docker
     directory: "testdata/project-v4"
     schedule:
       interval: "weekly"
+    commit-message:
+      prefix: ":seedling:"
 
   # Maintain dependencies for go in external plugin sample
   - package-ecosystem: "gomod"
     directory: "docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1"
     schedule:
       interval: "weekly"
+    commit-message:
+      prefix: ":seedling:"
     labels:
       - "ok-to-test"

.github/workflows/lint-sample.yml

@@ -38,14 +38,14 @@ jobs:
       - name: Clone the code
         uses: actions/checkout@v4
       - name: Run linter
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
           version: v1.54
           working-directory: testdata/project-v4-with-deploy-image
           args: --config .golangci.yml ./...
           skip-cache: true  # first lint action will handle
       - name: Run linter
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
           version: v1.54
           working-directory: testdata/project-v4-multigroup-with-deploy-image

.github/workflows/lint.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Clone the code
         uses: actions/checkout@v4
       - name: Run linter
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
           version: v1.54
 

.github/workflows/spaces.yml

@@ -0,0 +1,22 @@
+name: Trailing
+
+# Trigger the workflow on pull requests and direct pushes to any branch
+on:
+  push:
+    paths:
+      - '**/*.md'
+  pull_request:
+    paths:
+      - '**/*.md'
+
+jobs:
+  lint:
+    name: "Check Trailing"
+    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)
+    steps:
+      - name: Clone the code
+        uses: actions/checkout@v4
+      - name: Run check
+        run: make test-spaces

CONTRIBUTING.md

@@ -170,7 +170,8 @@ separately.
 
 The docs are published off of three branches:
 
-- `book-v3`: [book.kubebuilder.io](https://book.kubebuilder.io) -- current docs
+- `book-v4`: [book.kubebuilder.io](https://book.kubebuilder.io) -- current docs
+- `book-v3`: [book-v3.book.kubebuilder.io](https://book-v3.book.kubebuilder.io) -- legacy docs
 - `book-v2`: [book-v2.book.kubebuilder.io](https://book-v2.book.kubebuilder.io) -- legacy docs
 - `book-v1`: [book-v1.book.kubebuilder.io](https://book-v1.book.kubebuilder.io) -- legacy docs
 - `master`: [master.book.kubebuilder.io](https://master.book.kubebuilder.io) -- "nightly" docs

Makefile

@@ -66,6 +66,12 @@ install: build ## Build and install the binary with the current source code. Use
 .PHONY: generate
 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
+	remove-spaces
+
+.PHONY: remove-spaces
+remove-spaces:
+	@echo "Removing trailing spaces"
+	@find . -type f -name "*.md" -exec sed -i '' 's/[[:space:]]*$$//' {} +
 
 .PHONY: generate-testdata
 generate-testdata: ## Update/generate the testdata in $GOPATH/src/sigs.k8s.io/kubebuilder
@@ -160,3 +166,7 @@ test-book: ## Run the cronjob tutorial's unit tests to make sure we don't break
 .PHONY: test-license
 test-license:  ## Run the license check
 	./test/check-license.sh
+
+.PHONY: test-spaces
+test-spaces:  ## Run the trailing spaces check
+	./test/check_spaces.sh

README.md

@@ -23,10 +23,10 @@ Kubebuilder is developed on top of the [controller-runtime][controller-runtime]
 ### Kubebuilder is also a library
 
 Kubebuilder is extensible and can be used as a library in other projects.
-[Operator-SDK][operator-sdk] is a good example of a project that uses Kubebuilder as a library. 
+[Operator-SDK][operator-sdk] is a good example of a project that uses Kubebuilder as a library.
 [Operator-SDK][operator-sdk] uses the plugin feature to include non-Go operators _e.g. operator-sdk's Ansible and Helm-based language Operators_.
 
-To learn more see [how to create your own plugins][your-own-plugins]. 
+To learn more see [how to create your own plugins][your-own-plugins].
 
 ### Installation
 
@@ -39,9 +39,9 @@ See the [Getting Started](https://book.kubebuilder.io/quick-start.html) document
 
 ![Quick Start](docs/gif/kb-demo.v3.11.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 
+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
@@ -52,7 +52,7 @@ Check out the Kubebuilder [book](https://book.kubebuilder.io).
 
 - Kubebuilder Book: [book.kubebuilder.io](https://book.kubebuilder.io)
 - GitHub Repo: [kubernetes-sigs/kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
-- Slack channel: [#kubebuilder](https://slack.k8s.io/#kubebuilder)
+- Slack channel: [#kubebuilder](https://kubernetes.slack.com/messages/#kubebuilder)
 - Google Group: [kubebuilder@googlegroups.com](https://groups.google.com/forum/#!forum/kubebuilder)
 - Design Documents: [designs](designs/)
 - Plugin: [plugins][plugin-section]
@@ -121,18 +121,18 @@ Before starting any work, please either comment on an existing issue, or file a
 
 ## Supportability
 
-Currently, Kubebuilder officially supports OSX and Linux platforms. 
-So, if you are using a Windows OS you may find issues. Contributions towards 
+Currently, Kubebuilder officially supports OSX and Linux platforms.
+So, if you are using a Windows OS you may find issues. Contributions towards
 supporting Windows are welcome.
 
 ### Apple Silicon
 
 Apple Silicon (`darwin/arm64`) support begins with the `go/v4` plugin.
 
 ## Community Meetings
- 
+
 The following meetings happen biweekly:
-  
+
 - Kubebuilder Meeting
 
 You are more than welcome to attend. For further info join to [kubebuilder@googlegroups.com](https://groups.google.com/g/kubebuilder).

RELEASE.md

@@ -25,14 +25,14 @@ process was done to ensure that we have an aligned process under the org (simila
 > **Note**
 > - You will need to have checkout locally from the remote repository the previous branch
 > - Also, ensure that you fetch all tags from the remote `git fetch --all --tags`
-> - Also, if you face issues to generate the release notes you might want to able to sort it out by running i.e.: 
+> - Also, if you face issues to generate the release notes you might want to able to sort it out by running i.e.:
 > `go run sigs.k8s.io/kubebuilder-release-tools/notes --use-upstream=false --from=v3.11.0 --branch=release-X`
 
 
 ### Draft a new release from GitHub
 
 1. Create a new tag with the correct version from the new `release-<MAJOR.MINOR>` branch
-2. Verify the Release Github Action. It should build the assets and publish in the draft release 
+2. Verify the Release Github Action. It should build the assets and publish in the draft release
 3. You also need to manually add the changelog generated above on the release page and publish it. Now, the code source is released !
 
 ### Update the website docs (https://book.kubebuilder.io/quick-start.html)
@@ -75,7 +75,7 @@ This action will caall the job [./build/.goreleaser.yml](./build/.goreleaser.yml
 Kubebuilder projects requires artifacts which are used to do test with ENV TEST (when we call `make test` target)
 These artifacts can be checked in the service page: https://storage.googleapis.com/kubebuilder-tools
 
-The build is made from the branch [tools-releases](https://github.com/kubernetes-sigs/kubebuilder/tree/tools-releases) and the trigger will call the `build/cloudbuild_tools.yaml` passing 
+The build is made from the branch [tools-releases](https://github.com/kubernetes-sigs/kubebuilder/tree/tools-releases) and the trigger will call the `build/cloudbuild_tools.yaml` passing
 as argument the architecture and the SO that should be used, e.g:
 
 <img width="553" alt="Screenshot 2022-04-30 at 10 15 41" src="https://user-images.githubusercontent.com/7708031/166099666-ae9cd2df-73fe-47f6-a987-464f63df9a19.png">
@@ -91,7 +91,7 @@ These images are can be checked in the consolse, see [here](https://console.clou
 
 The project `kube-rbac-proxy` is in the process to be donated to the k8s org. However, it is going on for a long time and then,
 we have no ETA for that to occur. When that occurs we can automate this process. But until there we need to generate these images
-by bumping the versions/tags released by `kube-rbac-proxy` on the branch 
+by bumping the versions/tags released by `kube-rbac-proxy` on the branch
 [kube-rbac-proxy-releases](https://github.com/kubernetes-sigs/kubebuilder/tree/kube-rbac-proxy-releases)
 then the `build/cloudbuild_kube-rbac-proxy.yaml` will generate the images.
 
@@ -118,8 +118,8 @@ and not the image, see:
         github_token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-However, the image should still be built and maintained since other projects under the org might be using them. 
+However, the image should still be built and maintained since other projects under the org might be using them.
 
 [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