docs: explain --workspace_status_command usage with example #28446
+34
−1
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 does this PR do?
This PR adds a new Usage subsection under
--workspace_status_commandin the user manual.The existing documentation explains how to provide a workspace status script, but does not show how build rules can actually consume the generated values. This change fills that gap.
What’s included?
bazel-out/stable-status.txtbazel-out/volatile-status.txtgenruleexample showing how stamped rules can read values fromstable-status.txtWhy is this useful?
Users frequently ask how to use values produced by
--workspace_status_commandinside rules (e.g. for embedding build metadata). This documentation provides a minimal, concrete example without requiring custom Starlark rules.Verification
I verified the examples locally by:
genrulethat reads fromstable-status.txtFixes #21200