docs(man): redact IP-like defaults for address flags in generated man page - Fixes #5894#5948
Open
AbhinavSivanandhan wants to merge 1 commit intonektos:masterfrom
Open
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
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.
Problem:
act --man-pageembeds the local outbound IP in defaults for address flags (e.g., --artifact-server-addr, --cache-server-addr). That breaks reproducible builds and leaks a private detail.Approach:
Only for documentation generation, replace printed defaults that:
with a deterministic placeholder: [auto-detected IP].
Runtime behavior is unchanged. When
actactually runs, it still uses the dynamic outbound IP.Implementation:
generateManPage()that walks the root command (and subcommands) and rewritesDefValuefor matching flags.TestSanitizeFlagDefaultsForDocsvalidates behavior across persistent/local flags and subcommands.Testing
go test ./cmd -run Sanitize -vpasses./act --man-pageshows[auto-detected IP]in place of a real IP for address flags.Fixes #5894