Skip to content

Commit 0c7d75d

Browse files
CopilotAArnott
andcommitted
Add documentation callout for version inheritance use case
Co-authored-by: AArnott <[email protected]>
1 parent 5183999 commit 0c7d75d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docfx/docs/versionJson.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,4 +106,7 @@ This allows version height offsets to implicitly reset as intended when the vers
106106

107107
In this example, the offset of 100 will be applied as long as the version remains "1.0-beta". When you update the version to "1.1-alpha" (which would reset the version height), the offset will be automatically ignored because "1.1-alpha" does not match "1.0-beta".
108108

109+
> [!NOTE]
110+
> This feature is particularly useful when a `version.json` file uses `"inherit": true` to get the version from a parent `version.json` file higher in the source tree. In such cases, you can set `versionHeightOffset` and `versionHeightOffsetAppliesTo` in the inheriting file without having to update it when the parent version changes. The offset will automatically stop applying when the inherited version no longer matches `versionHeightOffsetAppliesTo`.
111+
109112
[Learn more about pathFilters](path-filters.md).

0 commit comments

Comments
 (0)