feat(template): Generate NOTES.txt for every operator chart - #646
Merged
Conversation
helm install currently prints nothing. This adds the NOTES.txt that
hive-operator#753 and kafka-operator#1013 landed per repo, generated instead so
the remaining twelve do not need hand-written copies.
The template needs no new configuration. The three fields it varies on already
exist and are already used the same way by README.md.j2:
operator.pretty_string the product name
operator.product_string the documentation slug
operator.hub_component_slug | default(product_string) the Hub slug, which
only spark-k8s overrides
operator.config.has_product | default(true) the gate below
commons, listener and secret have has_product false, so they get different prose
and no Hub link, because they own no product custom resource and have no Hub
component page. Their pretty_string already ends in "Operator", so the sentence
uses chart_title for them and would otherwise read "the Stackable operator for
Stackable Secret Operator".
Output is byte-identical to the NOTES.txt already merged in hive-operator and
kafka-operator, and to the files in the open trino-operator and zookeeper-operator
pull requests, so the next rollout adds the file to twelve charts and shows no
diff for those four.
Techassi
approved these changes
Sep 8, 2026
lfrancke
marked this pull request as ready for review
September 8, 2026 09:06
20 tasks
lfrancke
moved this from Development: Done
to Acceptance: In Progress
in Stackable Engineering
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I started rolling out
NOTES.txtfor Helm by hand in all operators because I thought it'd be too complicated to special-case them. Turns out we have all the necessary plumbing already in operator-templating.The special handling is needed due to commons, listener and secret operator not having a "product".
This installs the Stackable operator for Secret Operator only.<-- WrongInstead it does now emit
This installs the Stackable Secret Operator only.