docs: address remaining #739 documentation updates - #768
Open
ianpittwood wants to merge 1 commit into
Open
Conversation
…739) Follow-up to the --metadata-file single-platform guard, closing the remaining documentation gaps from #739: - imagetools merge help no longer claims input is `--strategy build`-only; both strategies produce valid `--metadata-file` input. - build --metadata-file help documents per-UID keying and the write semantics (build: after all targets succeed; bake: buildx owns the file). - build --plan help notes it is bake-only and errors under --strategy build. - New "Build Strategies" section in docs/index.qmd consolidates strategy differences (parallelism, --plan, --fail-fast scope, metadata write semantics) and documents the one-platform-per-invocation constraint plus its two concrete consumer consequences (dgoss digest fallback, merge source loss). Refs #739
bschwedler
approved these changes
Aug 27, 2026
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.
What
Stacked on #767. Closes the remaining documentation gaps in #739 (docs/help only — no logic changes).
Changes
imagetools mergehelp — no longer claims input is produced bybakery build --strategy build; reworded to "produced bybakery build --metadata-file(either build strategy)", since either strategy now emits thesame contract.
build --metadata-filehelp — documents that entries are keyed byimage-target UID and the write semantics: with
--strategy buildthe file iswritten only after all targets succeed; with
--strategy bakebuildx ownsthe file.
build --planhelp — notes it is bake-only and errors out under--strategy build.docs/index.qmd— new "Build Strategies" section consolidating thestrategy differences (parallelism,
--plan,--fail-fastscope, metadatawrite semantics) in one discoverable place, plus the
one-platform-per-invocation constraint and its two concrete consumer
consequences (dgoss digest fallback, imagetools merge source loss).
Acceptance criteria (#739)
--strategy build-only.docs/index.qmd).--metadata-file.Base
Targets
fix/739-metadata-single-platform(#767). Rebase ontomainonce #767 merges.Refs #739