🌱 (ci): Add GH action to validate generated helm charts for tutorials #4472

akagami-harsh · 2025-01-06T21:23:14Z

Fixes Use the plugin to create a Helm Chart for Tutorials and Validate with them with GitHub action in the CI #4453
added a gh action to validate generated helm charts under docs/book/
modified Makefile to generate charts for tutorials
ran make generate-charts to generate charts for
docs/book/src/cronjob-tutorial/testdata/project
docs/book/src/getting-started/testdata/project
docs/book/src/multiversion-tutorial/testdata/project

k8s-ci-robot · 2025-01-06T21:23:23Z

Welcome @akagami-harsh!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-01-06T21:23:23Z

Hi @akagami-harsh. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

Makefile

hack/docs/internal/cronjob-tutorial/generate_cronjob.go

.github/workflows/test-helm-book.yml

camilamacedo86 · 2025-01-07T18:15:27Z

/lgtm
/approve

camilamacedo86 · 2025-01-07T18:24:58Z

HI @akagami-harsh
See that is failing: https://github.com/kubernetes-sigs/kubebuilder/actions/runs/12651921723/job/35270619225?pr=4472

You need to run make generate so that all under test data and docs samples will be generated within

/lgtm /approve cancel

mateusoliveira43 · 2025-01-14T11:24:45Z

hack/docs/internal/cronjob-tutorial/generate_cronjob.go

@@ -137,6 +137,10 @@ func (sp *Sample) CodeGen() {
 	cmd = exec.Command("make", "build-installer")
 	_, err = sp.ctx.Run(cmd)
 	hackutils.CheckError("Failed to run make build-installer for cronjob tutorial", err)
+
+	cmd = exec.Command("kubebuilder", "edit", "--plugins=helm.kubebuilder.io/v1-alpha")


These commands should use this function instead, no?

kubebuilder/test/e2e/utils/test_context.go

Lines 372 to 377 in d063d5a

// EditHelmPlugin is for running `kubebuilder edit --plugins=helm.kubebuilder.io/v1-alpha`

func (t *TestContext) EditHelmPlugin() error {

cmd := exec.Command(t.BinaryName, "edit", "--plugins=helm/v1-alpha")

_, err := t.Run(cmd)

return err

}

err := sp.ctx.EditHelmPlugin()

Yes we can use that function, I've updated the code to use that function.

camilamacedo86 · 2025-01-17T20:19:10Z

Hi @akagami-harsh

It is all great !!!
Sorry for the delay.
Could you please rebase it with the master so we can get it merged?

camilamacedo86 · 2025-01-17T20:30:53Z

If it passes in the CI, you do not need to do the rebase; if not, then it will be required.

/lgtm
/approve

Thank you a lot for your amazing work 🥇

akagami-harsh · 2025-01-17T21:42:43Z

Testdata verification ci was failing so ran make generate, now everything seem fine

camilamacedo86

/lgtm

k8s-ci-robot · 2025-01-17T21:59:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: akagami-harsh, camilamacedo86, mateusoliveira43

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

camilamacedo86 · 2025-01-20T13:08:02Z

HI @akagami-harsh

For we move forward we need to fix [Testdata verification / Verify testdata directory (pull_request)](https://github.com/kubernetes-sigs/kubebuilder/actions/runs/12837254288/job/35801318191?pr=4472)

Could you please rebase with the master and run make generate to do so?

k8s-ci-robot · 2025-01-20T13:17:11Z

@akagami-harsh: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-kubebuilder-e2e-k8s-1-32-0	`5cca7b1`	link	true	`/test pull-kubebuilder-e2e-k8s-1-32-0`

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.

akagami-harsh · 2025-01-20T13:26:21Z

Hi @camilamacedo86, i have rebased with master ran make make generate

camilamacedo86 · 2025-01-20T13:44:42Z

/lgtm

/skip pull-kubebuilder-e2e-k8s-1-32-0

camilamacedo86 · 2025-01-20T17:39:56Z

/skip pull-kubebuilder-e2e-k8s-1-32-0

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 6, 2025

k8s-ci-robot requested review from Kavinjsir and rashmigottipati January 6, 2025 21:23

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 6, 2025

camilamacedo86 reviewed Jan 7, 2025

View reviewed changes

Makefile Show resolved Hide resolved

camilamacedo86 reviewed Jan 7, 2025

View reviewed changes

hack/docs/internal/cronjob-tutorial/generate_cronjob.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jan 7, 2025

View reviewed changes

.github/workflows/test-helm-book.yml Show resolved Hide resolved

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch 2 times, most recently from 18fcd64 to 28d7925 Compare January 7, 2025 12:14

camilamacedo86 reviewed Jan 7, 2025

View reviewed changes

.github/workflows/test-helm-book.yml Show resolved Hide resolved

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 28d7925 to c451ce3 Compare January 7, 2025 12:49

k8s-ci-robot assigned camilamacedo86 Jan 7, 2025

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 7, 2025

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 7, 2025

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 1cc2116 to c451ce3 Compare January 7, 2025 23:38

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 7cdd469 to 12c4683 Compare January 8, 2025 21:24

mateusoliveira43 reviewed Jan 14, 2025

View reviewed changes

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 10a1b60 to 1f2292f Compare January 14, 2025 12:15

mateusoliveira43 approved these changes Jan 14, 2025

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 17, 2025

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from a50ed75 to 4b8cf1d Compare January 17, 2025 20:40

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 17, 2025

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 4b8cf1d to d906d37 Compare January 17, 2025 21:07

k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 17, 2025

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 8a65818 to 1f2292f Compare January 17, 2025 21:18

k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 17, 2025

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch 3 times, most recently from 88b398e to 69b2412 Compare January 17, 2025 21:37

camilamacedo86 approved these changes Jan 17, 2025

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 17, 2025

add gh action to validate book helm charts

5cca7b1

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 69b2412 to 5cca7b1 Compare January 20, 2025 13:15

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 20, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 20, 2025

camilamacedo86 merged commit 48db38c into kubernetes-sigs:master Jan 20, 2025
5 of 7 checks passed

akagami-harsh deleted the create-Helm-Chart-for-Tutorials branch January 21, 2025 08:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 (ci): Add GH action to validate generated helm charts for tutorials #4472

🌱 (ci): Add GH action to validate generated helm charts for tutorials #4472

akagami-harsh commented Jan 6, 2025

k8s-ci-robot commented Jan 6, 2025

k8s-ci-robot commented Jan 6, 2025

camilamacedo86 commented Jan 7, 2025

camilamacedo86 commented Jan 7, 2025

mateusoliveira43 Jan 14, 2025

akagami-harsh Jan 14, 2025

camilamacedo86 commented Jan 17, 2025

camilamacedo86 commented Jan 17, 2025 •

edited

Loading

akagami-harsh commented Jan 17, 2025

camilamacedo86 left a comment

k8s-ci-robot commented Jan 17, 2025

camilamacedo86 commented Jan 20, 2025

k8s-ci-robot commented Jan 20, 2025

akagami-harsh commented Jan 20, 2025

camilamacedo86 commented Jan 20, 2025

camilamacedo86 commented Jan 20, 2025

	// EditHelmPlugin is for running `kubebuilder edit --plugins=helm.kubebuilder.io/v1-alpha`
	func (t *TestContext) EditHelmPlugin() error {
	cmd := exec.Command(t.BinaryName, "edit", "--plugins=helm/v1-alpha")
	_, err := t.Run(cmd)
	return err
	}

🌱 (ci): Add GH action to validate generated helm charts for tutorials #4472

🌱 (ci): Add GH action to validate generated helm charts for tutorials #4472

Conversation

akagami-harsh commented Jan 6, 2025

k8s-ci-robot commented Jan 6, 2025

k8s-ci-robot commented Jan 6, 2025

camilamacedo86 commented Jan 7, 2025

camilamacedo86 commented Jan 7, 2025

mateusoliveira43 Jan 14, 2025

Choose a reason for hiding this comment

akagami-harsh Jan 14, 2025

Choose a reason for hiding this comment

camilamacedo86 commented Jan 17, 2025

camilamacedo86 commented Jan 17, 2025 • edited Loading

akagami-harsh commented Jan 17, 2025

camilamacedo86 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 17, 2025

camilamacedo86 commented Jan 20, 2025

k8s-ci-robot commented Jan 20, 2025

akagami-harsh commented Jan 20, 2025

camilamacedo86 commented Jan 20, 2025

camilamacedo86 commented Jan 20, 2025

camilamacedo86 commented Jan 17, 2025 •

edited

Loading