🌱 Update cronjob-tutorial automatically (#3231)

* Bump github.com/onsi/ginkgo/v2 from 2.8.0 to 2.8.1

Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.8.0 to 2.8.1.
- [Release notes](https://github.com/onsi/ginkgo/releases)
- [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md)
- [Commits](onsi/ginkgo@v2.8.0...v2.8.1)

---
updated-dependencies:
- dependency-name: github.com/onsi/ginkgo/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* feat: update cronjob-tutorial automatically

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: Eileen-Yu

.golangci.yml

@@ -11,6 +11,10 @@ issues:
   exclude-rules:
     - linters: [gosec]
       path: "test/e2e/*"
+    - path: "hack/docs/*"
+      linters:
+        - lll
+        - gosec
 
 linters-settings:
   govet:

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_types.go

@@ -17,10 +17,12 @@ limitations under the License.
 
 /*
  */
+
 package v1
 
 /*
  */
+
 import (
 	batchv1 "k8s.io/api/batch/v1"
 	corev1 "k8s.io/api/core/v1"

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

@@ -54,7 +54,7 @@ This marker is responsible for generating a mutating webhook manifest.
 The meaning of each marker can be found [here](/reference/markers/webhook.md).
 */
 
-//+kubebuilder:webhook:path=/mutate-batch-tutorial-kubebuilder-io-v1-cronjob,mutating=true,failurePolicy=fail,sideEffects=None,groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=create;update,versions=v1,name=mcronjob.kb.io,admissionReviewVersions=v1
+//+kubebuilder:webhook:path=/mutate-batch-tutorial-kubebuilder-io-v1-cronjob,mutating=true,failurePolicy=fail,groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=create;update,versions=v1,name=mcronjob.kb.io,sideEffects=None,admissionReviewVersions=v1
 
 /*
 We use the `webhook.Defaulter` interface to set defaults to our CRD.

docs/book/src/cronjob-tutorial/testdata/project/api/v1/groupversion_info.go

@@ -39,6 +39,7 @@ Since we need to use all the types in this package in our controller, it's
 helpful (and the convention) to have a convenient method to add all the types to
 some other `Scheme`. SchemeBuilder makes this easy for us.
 */
+
 var (
 	// GroupVersion is group version used to register these objects
 	GroupVersion = schema.GroupVersion{Group: "batch.tutorial.kubebuilder.io", Version: "v1"}

docs/book/src/cronjob-tutorial/testdata/project/cmd/main.go

@@ -20,7 +20,6 @@ package main
 import (
 	"flag"
 	"os"
-	"tutorial.kubebuilder.io/project/internal/controller"
 
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
 	// to ensure that exec-entrypoint and run can make use of them.
@@ -34,6 +33,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
 	batchv1 "tutorial.kubebuilder.io/project/api/v1"
+	"tutorial.kubebuilder.io/project/internal/controller"
 	//+kubebuilder:scaffold:imports
 )
 
@@ -47,6 +47,7 @@ objects in our controller.
 If we would be using any other CRD we would have to add their scheme the same way.
 Builtin types such as Job have their scheme added by `clientgoscheme`.
 */
+
 var (
 	scheme   = runtime.NewScheme()
 	setupLog = ctrl.Log.WithName("setup")

docs/book/src/cronjob-tutorial/testdata/project/config/samples/batch_v1_cronjob.yaml

@@ -23,4 +23,5 @@ spec:
             - /bin/sh
             - -c
             - date; echo Hello from the Kubernetes cluster
-          restartPolicy: OnFailure
+          restartPolicy: OnFailure
+  

docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller.go

@@ -19,6 +19,7 @@ limitations under the License.
 We'll start out with some imports.  You'll see below that we'll need a few more imports
 than those scaffolded for us.  We'll talk about each one when we use it.
 */
+
 package controller
 
 import (
@@ -547,6 +548,7 @@ var (
 	apiGVStr    = batchv1.GroupVersion.String()
 )
 
+// SetupWithManager sets up the controller with the Manager.
 func (r *CronJobReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	// set up a real clock, since we're not in a test
 	if r.Clock == nil {

docs/book/src/cronjob-tutorial/testdata/project/internal/controller/suite_test.go

@@ -22,6 +22,7 @@ Kubebuilder scaffolded a `internal/controller/suite_test.go` file that does the
 First, it will contain the necessary imports.
 */
 
+
 package controller
 
 import (
@@ -33,6 +34,7 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"

hack/docs/check.sh

@@ -14,6 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+source "$(dirname "$0")/../../test/common.sh"
+
+build_kb
 
 check_directory="$(dirname "$0")/../../docs/book/src/"
 

hack/docs/generate_samples.go

@@ -19,7 +19,9 @@ package main
 import (
 	"fmt"
 
-	componentconfig "sigs.k8s.io/kubebuilder/v3/hack/docs/internal"
+	componentconfig "sigs.k8s.io/kubebuilder/v3/hack/docs/internal/component-config-tutorial"
+	cronjob "sigs.k8s.io/kubebuilder/v3/hack/docs/internal/cronjob-tutorial"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin/util"
 )
 
 func main() {
@@ -28,13 +30,13 @@ func main() {
 	fmt.Println("Generating component-config tutorial...")
 	UpdateComponentConfigTutorial()
 
-	// TODO: Generate cronjob-tutorial
-
+	fmt.Println("Generating cronjob tutorial...")
+	UpdateCronjobTutorial()
 	// TODO: Generate multiversion-tutorial
 }
 
 func UpdateComponentConfigTutorial() {
-	binaryPath := "/tmp/kubebuilder/bin/kubebuilder"
+	binaryPath := util.KubebuilderBinName
 	samplePath := "docs/book/src/component-config-tutorial/testdata/project/"
 
 	sp := componentconfig.NewSample(binaryPath, samplePath)
@@ -47,3 +49,16 @@ func UpdateComponentConfigTutorial() {
 
 	sp.CodeGen()
 }
+
+func UpdateCronjobTutorial() {
+	binaryPath := util.KubebuilderBinName
+	samplePath := "docs/book/src/cronjob-tutorial/testdata/project/"
+
+	sp := cronjob.NewSample(binaryPath, samplePath)
+
+	sp.Prepare()
+
+	sp.GenerateSampleProject()
+
+	sp.UpdateTutorial()
+}