docs: document inline --set override syntax for ssh and composable attributes#3882
Open
mvanhorn wants to merge 1 commit into
Open
docs: document inline --set override syntax for ssh and composable attributes#3882mvanhorn wants to merge 1 commit into
mvanhorn wants to merge 1 commit into
Conversation
…tributes Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
3 tasks
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.
Summary
Documents the inline
--setoverride string syntax for thesshfield (and theother composable list attributes) in the bake reference docs:
docs/reference/buildx_bake.md: adds an "Inline values for composableattributes" subsection under
--set, showing--set "*.ssh=default=$HOME/.ssh/id_ed25519",the comma-separated multi-path form, and which fields support sub-key selectors.
docs/bake-reference.md: adds a note in thetarget.sshsection pointing tothe inline
id=pathform used by--set.Why this matters
Issue #3556 reported that
--set "*.ssh.paths=..."silently setsidinstead ofpaths. As jsternberg noted, the behavior is actually supported via the inlineform
--set "*.ssh=default=$HOME/.ssh/id_ed25519"(multiple paths comma-separated),but that syntax was lost from the docs when the bake reference migrated examples to
the composable-attribute object form. This change restores the documentation for the
command-line inline form. Verified locally with
bake --print: the override resolvesto the expected
{ id: "default", paths: [...] }agent config.Fixes #3556
AI was used for assistance.