WIP: automatically diff KEP headings versus the template #5267
+101
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: BenTheElder The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
area/enhancements
k8s-ci-robot
added
the
size/L
BenTheElder
commented
May 1, 2025
| @@ -0,0 +1,100 @@ | |||
| #!/usr/bin/env bash | |||
There was a problem hiding this comment.
this is based on hack/update-toc.sh + hack/apidiff.sh (kubernetes/kubernetes)
BenTheElder
force-pushed
the
diff-kep-template
branch
from
eb4fc35 to
ea63ef8
Compare
BenTheElder
commented
May 1, 2025
| echo >&2 "Diffing table of contents for $kep_readme:" | ||
| # diff only removals versus the template | ||
| # we don't care about _additional_ headings in the KEP | ||
| # TODO: ignore certain allowed removals "(Optional)" |
There was a problem hiding this comment.
if we just stuck (Optional) in all of the optional headings (most already do), then this is already implemented.
proof of concept using mdtoc (which we already use for update-toc.sh)
BenTheElder
force-pushed
the
diff-kep-template
branch
from
ea63ef8 to
1c4a3e8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sharing a quick proof of concept using mdtoc (which we already use for update-toc.sh)
See thread: https://kubernetes.slack.com/archives/C5P3FE08M/p1746127465971139
TODO:
The gist is there though, we can check for any new questions that have been missed by diffing against the template for kep READMEs touched by the PR.