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

fix: add missing CRD link to helm chart readme #1563

Merged
merged 1 commit into from
Nov 16, 2024

Conversation

janeklb
Copy link
Contributor

@janeklb janeklb commented Nov 16, 2024

Motivation

The helm chart's README.md was missing instructions to update / apply the ClickhouseKeeperInstallation CRD.

Modifications

  • Add kubectl apply ... command for the CHK CRD to chart description
  • Add README.md.gotmpl (see note below)
  • Update README.md via helm-docs
  • Remove helm-docs minimum version comment in ./dev/generate_helm_chart.sh since it is no longer needed

Note on README.go.tmpl

This PR also includes a new file: README.md.gotmpl

The reason this file is being included is because it allows for strict control over what is included in the final README.md. The contents of this file are copy-pasted from the helm-docs defaults (you can find them below the table here), except for the last template section:

{{ template "helm-docs.versionFooter" . }}

This part has been omitted in order to preserve the current README.md format.

The same functionality can be achieved by using the --skip-version-footer flag when calling helm-docs. I had originally included this in dev/generate_helm_chart.sh as part of (#1555); however, it was subsequently removed in 3ae32ee by @sunsingerus.

Hopefully this approach is more suitable.


Important items to consider before making a Pull Request

Please check items PR complies to:

  • All commits in the PR are squashed. More info
  • The PR is made into dedicated next-release branch, not into master branch1. More info
  • The PR is signed. More info

The README was missing instructions to update / apply the ClickhouseKeeperInstallation CRD.
@Slach
Copy link
Collaborator

Slach commented Nov 16, 2024

Thanks for your contribution

@Slach Slach merged commit b08e1d4 into Altinity:0.24.1 Nov 16, 2024
2 checks passed
@janeklb janeklb deleted the jlb/missing-crd branch November 16, 2024 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants