docs: document fluid-build env vars and in-repo build-tools linking#27439
docs: document fluid-build env vars and in-repo build-tools linking#27439tylerbutler wants to merge 2 commits into
Conversation
|
Hi! Thank you for opening this PR. Want me to review it? Based on the diff (30 lines, 2 files), I've queued these reviewers:
How this works
|
There was a problem hiding this comment.
Pull request overview
Documentation-only updates to make fluid-build configuration more discoverable and easier to test locally by clarifying supported environment variables and documenting an opt-in pnpm override workflow for linking in-repo build-tools packages.
Changes:
- Refined the
fluid-buildenvironment variables section to document expected values and add two previously undocumented variables. - Added commented
pnpmoverride entries that contributors can uncomment to link in-repo build-tools packages for local testing.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pnpm-workspace.yaml | Adds commented-out overrides entries to optionally link in-repo build-tools packages for local validation. |
| build-tools/packages/build-tools/README.md | Updates fluid-build env var documentation (expected values, new vars, clarified prose). |
| | `FLUID_BUILD_ENABLE_GOODFENCE_HASH` | `1` | Enables content hashing for good-fence tasks | | ||
| | `FLUID_BUILD_ENABLE_DEPCRUISE_HASH` | `1` | Enables content hashing for dependency-cruiser tasks | | ||
| | `FLUID_BUILD_EXTENDED_METRICS_DISPLAY` | `true` or `1` | Displays extended build cache metrics | | ||
| | `FLUID_BUILD_TEST_RANDOM_ORDER` | `true` | Randomizes glob result ordering to help detect ordering dependencies in tests | |
| # GHSA-34x7-hfp2-rc4v). | ||
| tar: ^7.5.11 | ||
|
|
||
| # Uncomment the lines below and run pnpm install to link the in-repo copy of build tools |
Description
Documentation-only updates for
fluid-buildconfiguration.build-tools/packages/build-tools/README.md— Refresh the environment variables section: rename the table'sTaskcolumn toValueand document each variable's expected value, add the previously undocumentedFLUID_BUILD_EXTENDED_METRICS_DISPLAYandFLUID_BUILD_TEST_RANDOM_ORDERvariables, and clarify the surrounding prose.pnpm-workspace.yaml— Add commented-outoverridesentries (with a link to the build-tools README) that contributors can uncomment to link the in-repo copies of the build tools for local testing.Reviewer Guidance
The review process is outlined on this wiki page.