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

Outdated Helm chart README.md #609

Closed
mszostok opened this issue Jun 3, 2022 · 0 comments · Fixed by #642, kubeshop/botkube-docs#99 or kubeshop/botkube-docs#100
Closed

Outdated Helm chart README.md #609

mszostok opened this issue Jun 3, 2022 · 0 comments · Fixed by #642, kubeshop/botkube-docs#99 or kubeshop/botkube-docs#100
Assignees
Labels
enhancement New feature or request helm-chart Related to helm chart improvements
Projects
Milestone

Comments

@mszostok
Copy link
Contributor

mszostok commented Jun 3, 2022

Is your feature request related to a problem? Please describe.

The README.md for Helm chart contains outdated/missing properties.

For example props that are missing:

| communications.lark.appID | string | `"LARK_APP_ID"` |  |
| communications.lark.appSecret | string | `"LARK_APP_SECRET"` |  |
| communications.lark.chatGroup | string | `"LARK_CHAT_GROUP_ID"` |  |
| communications.lark.enabled | bool | `false` |  |
| communications.lark.encryptKey | string | `"LARK_ENCRYPT_KEY"` |  |
| communications.lark.endpoint | string | `"LARK_URL"` |  |
| communications.lark.messagePath | string | `"/bots/lark"` |  |
| communications.lark.port | int | `9999` |  |
| communications.lark.verificationToken | string | `"LARK_VERIFICATION_TOKEN"` |  |
| communications.teams.messagePath | string | `"/bots/teams"` |  |
| automountServiceAccountToken | bool | `true` |  |
| deployment.annotations | object | `{}` |  |
| serviceAccount.name | string | `""` |  |

Removed by still present:

| ingress.urlPath | string | `"/"` |  |

diff taken on 9cfc924

Describe the solution you'd like

To ensure that changes made to the Helm chart are always in sync with the README.md file, it would be nice to generate them automatically. There are some libs that make it possible:

It may require a small changes to the comment formatting, though.

@mszostok mszostok added enhancement New feature or request helm-chart Related to helm chart improvements labels Jun 3, 2022
@mszostok mszostok added this to the v0.13.0 milestone Jul 12, 2022
@mszostok mszostok added this to To do in v0.13.0 via automation Jul 12, 2022
@mszostok mszostok moved this from To do to In progress in v0.13.0 Jul 12, 2022
@mszostok mszostok self-assigned this Jul 12, 2022
@mszostok mszostok moved this from In progress to To review in v0.13.0 Jul 12, 2022
v0.13.0 automation moved this from To review to Done Jul 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request helm-chart Related to helm chart improvements
Projects
No open projects
1 participant