Auto-generate helm values in README.md #207
Closed
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.
This is a first crack at auto-generating the helm values in the README.md, as described briefly in #206. I'm not sure if this is a great idea, so I haven't finished this. I wanted to open this up to discussion before making any more progress.
One thing I'm not happy about is how the table contents are not rendered in an ascii readable way. I experimented with auto-formatting using prettier, but having both helm-docs and prettier modifying the file led to an always-fail scenario.
Another problem is that our values go so deep, the resulting table has horizontal scrolling that hides all but the left-most column. See https://github.com/astronomer/airflow-chart/blob/7384359163/README.md