🌱 (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.

camilamacedo86 · 2025-01-07T05:56:24Z

Makefile

 	(cd testdata/project-v4-with-plugins && ../../bin/kubebuilder edit --plugins=helm/v1-alpha)
+	(cd docs/book/src/getting-started/testdata/project && ../../../../../../bin/kubebuilder edit --plugins=helm/v1-alpha)
+	(cd docs/book/src/cronjob-tutorial/testdata/project && ../../../../../../bin/kubebuilder edit --plugins=helm/v1-alpha)
+	(cd docs/book/src/multiversion-tutorial/testdata/project && ../../../../../../bin/kubebuilder edit --plugins=helm/v1-alpha)


camilamacedo86 · 2025-01-07T05:58:28Z

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

+
+	cmd = exec.Command("make", "generate-charts")
+	_, err = sp.ctx.Run(cmd)
+	hackutils.CheckError("Failed to run make chart for cronjob tutorial", err)


The changes here are perfect 👍

I think this will not work

generate-charts command only exists in root Makefile, not in docs samples Makefile

Would need to do something like in testdata?

kubebuilder/test/testdata/generate.sh

Line 114 in 458615a

$kb edit --plugins=helm.kubebuilder.io/v1-alpha

Yep we need to call here the plugin.
Good catcher @mateusoliveira43 🥇

Could you please fix it @akagami-harsh ?

Hi @camilamacedo86, I’ve moved the plugin call to generate.sh . It should work now—could you please trigger the CI

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

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

/lgtm
/approve

k8s-ci-robot · 2025-01-07T18:15:35Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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

k8s-ci-robot · 2025-01-07T18:16:51Z

@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	`c451ce3`	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.

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

k8s-ci-robot · 2025-01-07T23:34:57Z

New changes are detected. LGTM label has been removed.

Signed-off-by: Your Name <[email protected]> generate charts for samples under docs Signed-off-by: Your Name <[email protected]> call chart Signed-off-by: Your Name <[email protected]> fix Signed-off-by: Your Name <[email protected]> generate charts Signed-off-by: Your Name <[email protected]> fix Signed-off-by: Your Name <[email protected]> fix Signed-off-by: Your Name <[email protected]> fix Signed-off-by: Your Name <[email protected]> fix Signed-off-by: Your Name <[email protected]>

camilamacedo86 · 2025-01-09T05:03:57Z

Makefile

@@ -89,7 +89,7 @@ generate-docs: ## Update/generate the docs
 	./hack/docs/generate.sh

 .PHONY: generate-charts
-generate-charts: build ## Re-generate the helm chart testdata only
+generate-charts: build ## Re-generate the helm chart testdata and docs samples
 	rm -rf testdata/project-v4-with-plugins/dist/chart
 	(cd testdata/project-v4-with-plugins && ../../bin/kubebuilder edit --plugins=helm/v1-alpha)


We are not re-generating the charts for docs here, right?
We need to do that because when we are developing the helm-chart plugin, and we want to test the changes, we just run make generate-charts and check things out without the need to re-scaffold all.

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

.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 the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 7, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label 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

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 8, 2025

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

akagami-harsh force-pushed the create-Helm-Chart-for-Tutorials branch from 12c4683 to 38a8f3c Compare January 8, 2025 21:26

camilamacedo86 reviewed Jan 9, 2025

View reviewed changes

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 Jan 7, 2025

camilamacedo86 Jan 7, 2025

mateusoliveira43 Jan 7, 2025

camilamacedo86 Jan 8, 2025

akagami-harsh Jan 8, 2025

camilamacedo86 commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

camilamacedo86 commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

camilamacedo86 Jan 9, 2025 •

edited

Loading

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

Are you sure you want to change the base?

🌱 (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 Jan 7, 2025

Choose a reason for hiding this comment

camilamacedo86 Jan 7, 2025

Choose a reason for hiding this comment

mateusoliveira43 Jan 7, 2025

Choose a reason for hiding this comment

camilamacedo86 Jan 8, 2025

Choose a reason for hiding this comment

akagami-harsh Jan 8, 2025

Choose a reason for hiding this comment

camilamacedo86 commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

camilamacedo86 commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

camilamacedo86 Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

camilamacedo86 Jan 9, 2025 •

edited

Loading