search

kubernetes / kube-state-metrics

Add-on agent to generate and expose cluster-level metrics.
https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/
Apache License 2.0
5.36k stars 2k forks source link

docs: Template the README file #2344

Closed mrueg closed 6 months ago

mrueg commented 6 months ago

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

k8s-ci-robot commented 6 months ago

This issue is currently awaiting triage.

If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
mrueg commented 6 months ago

@rexagod @dgrisonnet this is now ready for review and should simplify the release process a bit.

rexagod commented 6 months ago

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! 🙌🏼

mrueg commented 6 months ago

@rexagod great to hear, if there are no concerns with this approach, this is ready to go :)

rexagod commented 6 months ago

/lgtm

k8s-ci-robot commented 6 months ago

[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: - ~~[OWNERS](https://github.com/kubernetes/kube-state-metrics/blob/main/OWNERS)~~ [mrueg,rexagod] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment