Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Helm chart developer experience #1847

Open
2 of 3 tasks
lambdanis opened this issue Dec 5, 2023 · 1 comment
Open
2 of 3 tasks

Improve Helm chart developer experience #1847

lambdanis opened this issue Dec 5, 2023 · 1 comment
Labels
area/ci Related to CI area/documentation Improvements or additions to documentation area/helm Related to the Helm chart

Comments

@lambdanis
Copy link
Contributor

lambdanis commented Dec 5, 2023

The current state of the Helm chart devexp is the following:

  • install/kubernetes/test.sh script updates the Helm chart dependencies, validates it, and generates the values reference (chart README & docs page)
  • Lint helm chart CI workflow validates the Helm chart and its docs
  • There is a DEVELOP.md file, but it's outdated and it says nothing about testing the Helm chart or docs

To make Helm contributions easier I suggest to refactor these bits:

  • Introduce install/kubernetes/Makefile, so that make -C install/kubernetes does what is currently done by test.sh, but separate tasks can be also run with separate Makefile rules. Make the docs check a Makefile rule too.
  • These changes will require updating the CI, release process and Renovate config too
  • Remove DEVELOP.md and document the Helm development workflow in the Contribution Guide
@lambdanis lambdanis added area/documentation Improvements or additions to documentation area/ci Related to CI area/helm Related to the Helm chart labels Dec 5, 2023
@sadath-12
Copy link
Contributor

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci Related to CI area/documentation Improvements or additions to documentation area/helm Related to the Helm chart
Projects
None yet
Development

No branches or pull requests

2 participants