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

docs: Template the README file #2344

Merged
merged 1 commit into from
Apr 1, 2024
Merged

Conversation

mrueg
Copy link
Member

@mrueg mrueg commented Mar 18, 2024

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

  • Needs CI Integration / Fail if README.md is outdated
  • Needs header in README.md that changes need to be made in the template file

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 k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 18, 2024
@k8s-ci-robot
Copy link
Contributor

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 18, 2024
@mrueg mrueg changed the title docs: Template the README file WIP: docs: Template the README file Mar 18, 2024
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 18, 2024
@mrueg mrueg force-pushed the template-readme branch 2 times, most recently from 64b60d7 to cbd8fa6 Compare March 27, 2024 13:14
@mrueg mrueg changed the title WIP: docs: Template the README file docs: Template the README file Mar 27, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 27, 2024
@mrueg mrueg force-pushed the template-readme branch 2 times, most recently from 8c43d7d to b47f85d Compare March 27, 2024 13:17
@mrueg
Copy link
Member Author

mrueg commented Mar 27, 2024

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

@mrueg mrueg force-pushed the template-readme branch 2 times, most recently from 03dd7a4 to 9e42155 Compare March 27, 2024 18:35
tools/tools.go Outdated Show resolved Hide resolved
@rexagod
Copy link
Member

rexagod commented Mar 30, 2024

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 mrueg force-pushed the template-readme branch 4 times, most recently from fe13f67 to fc8c061 Compare March 30, 2024 19:51
@mrueg
Copy link
Member Author

mrueg commented Mar 30, 2024

@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.
Copy link
Member

@rexagod rexagod Mar 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> 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).

@rexagod
Copy link
Member

rexagod commented Apr 1, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 1, 2024
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 3f44ad0 into kubernetes:main Apr 1, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants