Skip to content

docs: document fluid-build env vars and in-repo build-tools linking#27439

Open
tylerbutler wants to merge 2 commits into
microsoft:mainfrom
tylerbutler:bt-docs
Open

docs: document fluid-build env vars and in-repo build-tools linking#27439
tylerbutler wants to merge 2 commits into
microsoft:mainfrom
tylerbutler:bt-docs

Conversation

@tylerbutler
Copy link
Copy Markdown
Member

@tylerbutler tylerbutler commented May 29, 2026

Description

Documentation-only updates for fluid-build configuration.

  • build-tools/packages/build-tools/README.md — Refresh the environment variables section: rename the table's Task column to Value and document each variable's expected value, add the previously undocumented FLUID_BUILD_EXTENDED_METRICS_DISPLAY and FLUID_BUILD_TEST_RANDOM_ORDER variables, and clarify the surrounding prose.
  • pnpm-workspace.yaml — Add commented-out overrides entries (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.

@github-actions
Copy link
Copy Markdown
Contributor

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:

  • Correctness — logic errors, race conditions, lifecycle issues
  • Security — vulnerabilities, secret exposure, injection
  • API Compatibility — breaking changes, release tags, type design
  • Performance — algorithmic regressions, memory leaks
  • Testing — coverage gaps, hollow tests

How this works

  • Adjust the reviewer set by ticking/unticking boxes above. Reviewer toggles alone don't trigger anything.

  • Tick Start review below to dispatch the review fleet.

  • After review finishes, tick Start review again to request another run — it auto-resets after each dispatch.

  • This comment updates as new commits land; your reviewer selections are preserved.

  • Start review

@tylerbutler tylerbutler changed the title docs: document fluid-build env vars docs: document fluid-build env vars and in-repo build-tools linking May 29, 2026
@tylerbutler tylerbutler marked this pull request as ready for review May 29, 2026 01:44
Copilot AI review requested due to automatic review settings May 29, 2026 01:44
@tylerbutler tylerbutler requested a review from a team May 29, 2026 01:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-build environment variables section to document expected values and add two previously undocumented variables.
  • Added commented pnpm override 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 |
Comment thread pnpm-workspace.yaml
# 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants