Skip to content

publish helm chart information when bumping versions #34114

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: docs-upcoming-v26.0.0
Choose a base branch
from
+444 −0
Open

publish helm chart information when bumping versions #34114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions bin/bump-version
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,20 @@ if [ "$(helm-docs --version)" != "helm-docs version $helm_docs_version" ]; then
exit 1
fi
helm-docs misc/helm-charts
(
cat <<'EOF'
---
description: "Reference page on the Materialize Operator Helm Chart"
Copy link
Contributor

@kay-kim kay-kim Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As an FYI ... we're missing the title field here, which is why it doesn't render.

Also, we can probably simplify this:

  • Don't bother with the front matter at all and just cat the README.md to doc/user/shared-content/operator-helm-chart-readme.md
  • Just have a static doc/user/content/installation/appendix-.... .md:
    • it has the front matter and includes the shared-content
      This way, if we need to tweak the front matter, the script doesn't need to change.
---
title: "Appendix: Materialize Operator Helm Chart Readme"
description: "Readme page on the Materialize Operator Helm Chart"
disable_list: true
menu:
  main:
    identifier: ""
    weight: 99

---

{{< include-md file="shared-content/operator-helm-chart-readme.md" >}}

And, I think we probably want to clean up the readme a bit? and I talked with @jubrad yesterday ... w.r.t. the the config options ... we currently have them displayed both as a table with the param and default value and a section below that has more description. https://materialize.com/docs/installation/configuration/#configure-the-materialize-operator ... the reason for this is to avoid having users scroll.

Copy link
Contributor

@kay-kim kay-kim Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ... and now reviewing the CRD reference generation page, I should meantion, @jubrad it doesn't havae to be .yml ... if it's easier for you all to use array of json docs, that's fine too (we'll just need to tweak the short codes)

menu:
main:
parent: "installation"
identifier: "appendix-materialize-operator-helm-chart"
weight: 98
---

EOF
cat misc/helm-charts/operator/README.md
) > doc/user/content/installation/appendix-materialize-operator-helm-chart.md

if $sbom; then
if ! inspector-sbomgen --version > /dev/null; then
Expand Down
Loading