🌱 (ci): Add linter for the samples scaffolded under docs #4464
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: jongwooo The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/M
|
/retitle 🌱 (ci): Add linter for the samples scaffolded under docs |
k8s-ci-robot
changed the title
This commit change the action to add linter for the samples scaffolded under docs Signed-off-by: Jongwoo Han <[email protected]>
jongwooo
force-pushed
the
ci/add-linter-for-the-samples-scaffolded-under-docs
branch
from
6784efa to
782e274
Compare
|
@jongwooo: The following test failed, say
Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
| @@ -129,7 +129,7 @@ var _ = Describe("CronJob controller", func() { | |||
| By("By checking the CronJob has zero active Jobs") | |||
| Consistently(func(g Gomega) { | |||
| g.Expect(k8sClient.Get(ctx, cronjobLookupKey, createdCronjob)).To(Succeed()) | |||
| g.Expect(createdCronjob.Status.Active).To(HaveLen(0)) | |||
| g.Expect(createdCronjob.Status.Active).To(HaveLen(0)) // nolint:ginkgolinter | |||
There was a problem hiding this comment.
hey @jongwooo
to apply changes to these files, you need to change code in hack/docs/internal folder, and then run make generate.
For example, for this line, you need to change it here
| @@ -96,6 +97,7 @@ var ( | |||
| // | |||
| // For more details, check Reconcile and its Result here: | |||
| // - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile | |||
| // nolint:gocyclo | |||
There was a problem hiding this comment.
HI @jongwooo
That is nice, but see that ALL samples under the docs are generated with the tools and we have a code implementation to add the code on top. They are generated automatically when we run make generate-docs.
See: https://github.com/kubernetes-sigs/kubebuilder/tree/master/hack/docs
So, the changes on the docs need to be addressed there.
There was a problem hiding this comment.
If we change anything that change the default scaffold then we run make generate which will re-generate the samples under testdata and the docs as well
docs/book/src/getting-started/testdata/project/internal/controller/memcached_controller.go
Show resolved
Hide resolved
docs/book/src/multiversion-tutorial/testdata/project/internal/controller/cronjob_controller.go
Show resolved
Hide resolved
docs/book/src/cronjob-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go
Show resolved
Hide resolved
docs/book/src/cronjob-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go
Show resolved
Hide resolved
docs/book/src/cronjob-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go
Show resolved
Hide resolved
...ok/src/multiversion-tutorial/testdata/project/internal/controller/cronjob_controller_test.go
Show resolved
Hide resolved
k8s-ci-robot
added
the
do-not-merge/work-in-progress
Fixes #4445
This pull request changes the action to add a linter for the samples scaffolded under docs, reorders imports for better readability, and adds
nolintcomments to suppress specific linter warnings./cc @camilamacedo86