-
Notifications
You must be signed in to change notification settings - Fork 2k
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
docs: Template the README file #2344
Conversation
This issue is currently awaiting triage. If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the The Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
64b60d7
to
cbd8fa6
Compare
8c43d7d
to
b47f85d
Compare
@rexagod @dgrisonnet this is now ready for review and should simplify the release process a bit. |
03dd7a4
to
9e42155
Compare
Whoa! This looks great, and I'm fairly confident it'll be able to handle various templating cases we throw at it with cleanliness, not to mention unblocking us on the release-automation front! Nicely done! 🙌🏼 |
fe13f67
to
fc8c061
Compare
@rexagod great to hear, if there are no concerns with this approach, this is ready to go :) |
README.md
Outdated
@@ -29,6 +29,9 @@ the raw metrics. Note that the metrics exposed on the `/metrics` endpoint | |||
reflect the current state of the Kubernetes cluster. When Kubernetes objects | |||
are deleted they are no longer visible on the `/metrics` endpoint. | |||
|
|||
> [!NOTE] | |||
> This README is generated from [./README.md.tpl]. Please make changes in the template file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> This README is generated from [./README.md.tpl]. Please make changes in the template file. | |
> This README is generated from [./README.md.tpl](./README.md.tpl). Please make changes in the template file. |
Ah, just a nit. We might need to append the path here, not sure if it is hyperlinked currently (Goland keeps telling me otherwise).
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mrueg, rexagod The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What this PR does / why we need it:
This is an alternative for automating releases further instead of a bashscript.
It would create an updated readme file based on the content in the data.yaml via
gomplate -d config=./data.yaml --file README.md.tpl > README.md
How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
None
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close the issue(s) when PR gets merged):Fixes #
/assign @rexagod