Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tylerbutler wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
911db55
docs: document fluid-build env vars
tylerbutler May 29, 2026
e2ebd2e
build-tools
tylerbutler May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions build-tools/packages/build-tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,17 +247,19 @@ the current state and previous build will determine whether the task needs to be

### Environment Variables

The following environment variables can be used to control incremental build behavior. By default, some tasks use
file timestamps for incremental detection. Setting these variables to `"1"` enables content-based hashing instead,
which avoids false rebuilds when timestamps change without meaningful content modification (e.g., after git operations
or file copies).

| Variable | Task | Description |
|----------|------|-------------|
| `FLUID_BUILD_ENABLE_COPYFILES_HASH` | CopyfilesTask | Enables content hashing for copyfiles tasks |
| `FLUID_BUILD_ENABLE_TYPEVALIDATION_HASH` | TypeValidationTask | Enables content hashing for type validation tasks |
| `FLUID_BUILD_ENABLE_GOODFENCE_HASH` | GoodFence | Enables content hashing for good-fence tasks |
| `FLUID_BUILD_ENABLE_DEPCRUISE_HASH` | DepCruiseTask | Enables content hashing for dependency-cruiser tasks |
The following environment variables can be used to control `fluid-build` behavior. By default, some tasks use file
timestamps for incremental detection. Setting the `FLUID_BUILD_ENABLE_*_HASH` variables to `"1"` enables content-based
hashing instead, which avoids false rebuilds when timestamps change without meaningful content modification (e.g., after
git operations or file copies).

| Variable | Value | Description |
|----------|-------|-------------|
| `FLUID_BUILD_ENABLE_COPYFILES_HASH` | `1` | Enables content hashing for copyfiles tasks |
| `FLUID_BUILD_ENABLE_TYPEVALIDATION_HASH` | `1` | Enables content hashing for type validation tasks |
| `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 |

Example:

Expand Down
6 changes: 6 additions & 0 deletions pnpm-workspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,12 @@ overrides:
# 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
# See https://github.com/microsoft/FluidFramework/blob/main/build-tools/README.md#testing-build-tools-changes-in-the-client-release-group
# "@fluid-tools/build-cli": "link:./build-tools/packages/build-cli"
# "@fluid-tools/version-tools": "link:./build-tools/packages/version-tools"
# "@fluidframework/build-tools": "link:./build-tools/packages/build-tools"

packages:
- "azure/packages/**"
- "examples/**"
Expand Down
Loading