ci: make the docs agree with the binary, since reading has not stuck - #73
Merged
Conversation
#54 lists README-versus-docs drift as an open item with the note "they have drifted before". They had, twice, and both times it was closed by reading. The last one was -serve-sts, named in four doc pages and in no README while being the flag that decides whether the KubeMicroVM operator starts at all. So this checks the part with a single right answer. Every flag the docs name is one the binary has; every flag the binary has is named somewhere; the operation totals the prose claims match what routes.go routes; and api-surface.md's per-family counts sum to that total — two numbers that are each individually plausible and do not add up is exactly the drift nobody notices. Deliberately not checked: that the README repeats what the docs say. It does not, on purpose — the README is a lead-in and docs/using-it.md is the reference, and a parity rule between them would fight that on every commit. Running it found three flags with no documentation at all: -addr, -log-level and -version. Documented rather than exempted, which is how the whole flag surface ended up in one table for the first time. Verified failing in both directions — a flag added to the binary with no row, and a row naming a flag that does not exist.
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
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.
Closes #68. Ticks another of #54's items, this one for good rather than until next time.
#54 lists README-versus-docs drift as open with the note "they have drifted before". They had, twice, and both times it was closed by reading. The last one was
-serve-sts— named in four doc pages and in no README, while being the flag that decides whether the KubeMicroVM operator starts at all.What it checks
Only things with a single right answer:
routes.goroutesapi-surface.md's per-family counts sum to that total — two numbers that are each individually plausible and do not add up is exactly the drift nobody noticesDeliberately not checked: that the README repeats what the docs say. It does not, on purpose — after #72 the README is a lead-in and
docs/using-it.mdis the reference. A parity rule between them would fight that on every commit.What running it found
Three flags with no documentation anywhere:
-addr,-log-level,-version. Documented rather than exempted, which is how the whole flag surface ended up in one table for the first time.Verified failing in both directions