docs: check documented flags against the binary in CI - #4041
Open
Giri-Aayush wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4041 +/- ##
==========================================
- Coverage 79.31% 79.17% -0.15%
==========================================
Files 464 464
Lines 35793 35787 -6
==========================================
- Hits 28389 28333 -56
- Misses 7395 7445 +50
Partials 9 9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
rodrodros
reviewed
Sep 5, 2026
Contributor
There was a problem hiding this comment.
I think it is better to add the job to docs-test.yml
rodrodros
reviewed
Sep 5, 2026
Comment on lines
+206
to
+209
| :::note | ||
| These flags were renamed from `--log-host` and `--log-port` in v0.14.4. When running in a container, set `--http-update-host=0.0.0.0`; the default binds localhost. | ||
| ::: | ||
|
|
rodrodros
reviewed
Sep 5, 2026
Contributor
There was a problem hiding this comment.
This seems awfully complicated and unnecessary. Why does this do?
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
2 participants
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.
Make CI prove the docs and the binary agree about flags.
Reason
CI only checked that the site builds. This checks every documented flag exists in the binary and the config table is complete, on docs PRs only, so Go PRs are never blocked. Its first run caught
--log-port, renamed in v0.14.4 and still on the live monitoring page. Fixes included.