feat(build-tools): add flag and environment variable to preserve version info in generated type tests #25988

Copilot · 2025-12-04T21:49:52Z

Description

Adds skipVersionOutput flag and FLUB_TYPETEST_SKIP_VERSION_OUTPUT environment variable to generate:typetests command. When set, preserves existing version information in generated type test file headers instead of updating to current package versions.

Implementation:

readExistingVersions() function: Parses existing type test files to extract baseline and current version comments
skipVersionOutput flag: Boolean flag with env property set to FLUB_TYPETEST_SKIP_VERSION_OUTPUT, allowing the value to be set via environment variable or command line. The flag is visible in help output for discoverability.
Version preservation logic: Uses the flag value to determine whether to preserve existing versions; falls back to current versions if file doesn't exist
Tests: Added test coverage for version reading (non-existent files, valid files, files without version info)
Pipeline integration: Automatically sets the environment variable in the Build - client pipeline for test/* branches using the existing testBuild variable

Usage:

# Regenerate type tests, preserving existing version comments (via environment variable)
FLUB_TYPETEST_SKIP_VERSION_OUTPUT=true flub generate:typetests --dir ./packages/my-package

# Or use the flag directly
flub generate:typetests --dir ./packages/my-package --skipVersionOutput

# Without flag/env var, versions update normally (default behavior)
flub generate:typetests --dir ./packages/my-package

Pipeline behavior: The environment variable is automatically set to true when building from test/* branches in CI. The oclif flag system automatically handles the type conversion from environment variable to boolean. This preserves existing version information during test branch builds without manual configuration.

Use case: in CI pipelines building from test branches, setting the version may not be the preferred behavior. This flag/env variable allows override.

Breaking Changes

None. Feature only activates when environment variable is set or flag is used.

Reviewer Guidance

Main logic in processPackage() around line 178-194
readExistingVersions() uses RegExp.exec() and "utf8" encoding per linting requirements
Tests use os.tmpdir() for cross-platform compatibility
Pipeline changes in tools/pipelines/templates/include-build-lint.yml use existing testBuild variable to automatically set the environment variable for test/* branches
Flag definition at line 83-88 uses env property for environment variable integration, following oclif best practices
Flag is visible in help output for better discoverability

Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

…ON_OUTPUT Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

tylerbutler · 2025-12-04T22:35:21Z

/azp run Build - protocol-definitions,Build - test-tools,server-gitrest,server-gitssh,server-routerlicious,Build - client packages,repo-policy-check,Build - build-tools

tylerbutler · 2025-12-04T22:35:25Z

/azp run Build - api-markdown-documenter,Build - benchmark-tool,Build - build-common,Build - build-tools,Build - common-utils,Build - eslint-config-fluid,Build - eslint-plugin-fluid,server-historian

azure-pipelines · 2025-12-04T22:35:39Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-12-04T22:35:40Z

Azure Pipelines successfully started running 2 pipeline(s).

tylerbutler · 2025-12-04T22:38:26Z

build-tools/packages/build-cli/src/commands/generate/typetests.ts

+		const previousVersionRegex = /Baseline \(previous\) version: (.+)/;
+		const currentVersionRegex = /Current version: (.+)/;
+		const previousVersionMatch = previousVersionRegex.exec(content);
+		const currentVersionMatch = currentVersionRegex.exec(content);


Seems easier than storing the metadata in the typetest field in package.json, even though it's brittle.

tylerbutler · 2025-12-04T22:39:24Z

/azp run Build - protocol-definitions,Build - test-tools,server-gitrest,server-gitssh,server-routerlicious,Build - client packages,repo-policy-check,Build - build-tools

tylerbutler · 2025-12-04T22:39:27Z

/azp run Build - api-markdown-documenter,Build - benchmark-tool,Build - build-common,Build - build-tools,Build - common-utils,Build - eslint-config-fluid,Build - eslint-plugin-fluid,server-historian

azure-pipelines · 2025-12-04T22:39:42Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-12-04T22:39:42Z

Azure Pipelines successfully started running 2 pipeline(s).

tylerbutler · 2025-12-05T00:47:04Z

@copilot Look at the ADO pipelines, specifically the Build - client pipeline. We want to set the new env var you created to 1 only when running a build from a test/* branch. I think we may already have variables for such cases to enable/disable parts of the pipeline, so we just need to find the righ one and thread it through.

build-tools/packages/build-cli/src/commands/generate/typetests.ts

- Add hidden skipVersionBump boolean flag - Set env property to FLUB_TYPETEST_SKIP_VERSION_OUTPUT - Use flag value instead of directly accessing process.env - Remove env variable from description (now in flag definition) - Simplify logic by removing string comparison checks Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

build-tools/packages/build-cli/src/commands/generate/typetests.ts

- Rename skipVersionBump to skipVersionOutput per review feedback - Remove hidden property to make flag visible in help output - Update all references throughout the code Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

tylerbutler · 2025-12-08T20:36:19Z

/azp run Build - protocol-definitions,Build - test-tools,server-gitrest,server-gitssh,server-routerlicious,Build - client packages,repo-policy-check,Build - build-tools

tylerbutler · 2025-12-08T20:36:23Z

/azp run Build - api-markdown-documenter,Build - benchmark-tool,Build - build-common,Build - build-tools,Build - common-utils,Build - eslint-config-fluid,Build - eslint-plugin-fluid,server-historian

azure-pipelines · 2025-12-08T20:36:39Z

Azure Pipelines successfully started running 2 pipeline(s).

azure-pipelines · 2025-12-08T20:36:43Z

Azure Pipelines successfully started running 1 pipeline(s).

tylerbutler · 2025-12-08T21:19:11Z

/azp run Build - protocol-definitions,Build - test-tools,server-gitrest,server-gitssh,server-routerlicious,Build - client packages,repo-policy-check,Build - build-tools

tylerbutler · 2025-12-08T21:19:16Z

/azp run Build - api-markdown-documenter,Build - benchmark-tool,Build - build-common,Build - build-tools,Build - common-utils,Build - eslint-config-fluid,Build - eslint-plugin-fluid,server-historian

azure-pipelines · 2025-12-08T21:19:31Z

Azure Pipelines successfully started running 2 pipeline(s).

azure-pipelines · 2025-12-08T21:19:31Z

Azure Pipelines successfully started running 1 pipeline(s).

build-tools/packages/build-cli/src/test/commands/generate/typetests.test.ts

Addresses PR feedback from Josmithr to add test coverage for the FLUB_TYPETEST_SKIP_VERSION_OUTPUT environment variable. Following the pattern from generate:buildVersion tests, added tests that: - Verify the flag has the correct env property configured - Test that the environment variable is properly read - Confirm the default value when env var is not set Also includes unit tests for the readExistingVersions function and version preservation behavior.

tylerbutler · 2025-12-09T01:17:19Z

/azp run Build - protocol-definitions,Build - test-tools,server-gitrest,server-gitssh,server-routerlicious,Build - client packages,repo-policy-check,Build - build-tools

tylerbutler · 2025-12-09T01:17:23Z

/azp run Build - api-markdown-documenter,Build - benchmark-tool,Build - build-common,Build - build-tools,Build - common-utils,Build - eslint-config-fluid,Build - eslint-plugin-fluid,server-historian

azure-pipelines · 2025-12-09T01:17:37Z

Azure Pipelines successfully started running 2 pipeline(s).

azure-pipelines · 2025-12-09T01:17:37Z

Azure Pipelines successfully started running 1 pipeline(s).

Initial plan

4584b15

Copilot AI assigned Copilot and tylerbutler Dec 4, 2025

Copilot started work on behalf of tylerbutler December 4, 2025 21:50 View session

Copilot AI and others added 3 commits December 4, 2025 22:03

Add FLUB_TYPETEST_SKIP_VERSION_OUTPUT environment variable support

213c32c

Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

Fix linting issues and add documentation for FLUB_TYPETEST_SKIP_VERSI…

e1416b9

…ON_OUTPUT Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

Fix cross-platform compatibility in test using os.tmpdir()

bba1042

Co-authored-by: tylerbutler <19589+tylerbutler@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add environment variable to skip version output in type tests~~ Add FLUB_TYPETEST_SKIP_VERSION_OUTPUT environment variable to preserve version info in generated type tests Dec 4, 2025

Copilot AI requested a review from tylerbutler December 4, 2025 22:13

Copilot finished work on behalf of tylerbutler December 4, 2025 22:13

tylerbutler changed the title ~~Add FLUB_TYPETEST_SKIP_VERSION_OUTPUT environment variable to preserve version info in generated type tests~~ feat(build-tools): add environment variable to preserve version info in generated type tests Dec 4, 2025

format

3f86722

tylerbutler reviewed Dec 4, 2025

View reviewed changes

Merge branch 'main' into copilot/add-env-var-to-skip-version-output

2fa4949

tylerbutler marked this pull request as ready for review December 4, 2025 22:39

tylerbutler requested review from a team and Copilot December 4, 2025 22:39

Copilot started reviewing on behalf of tylerbutler December 4, 2025 22:40 View session

Copilot finished reviewing on behalf of tylerbutler December 4, 2025 22:42

This comment was marked as outdated.

Sign in to view

Copilot started work on behalf of tylerbutler December 5, 2025 00:47 View session

Copilot AI requested a review from tylerbutler December 5, 2025 00:54

Copilot finished work on behalf of tylerbutler December 5, 2025 00:54

tylerbutler requested changes Dec 8, 2025

View reviewed changes

build-tools/packages/build-cli/src/commands/generate/typetests.ts Show resolved Hide resolved

Copilot started work on behalf of tylerbutler December 8, 2025 19:56 View session

Copilot AI changed the title ~~feat(build-tools): add environment variable to preserve version info in generated type tests~~ feat(build-tools): add flag and environment variable to preserve version info in generated type tests Dec 8, 2025

Copilot AI requested a review from tylerbutler December 8, 2025 20:03

Copilot finished work on behalf of tylerbutler December 8, 2025 20:03

tylerbutler requested changes Dec 8, 2025

View reviewed changes

build-tools/packages/build-cli/src/commands/generate/typetests.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of tylerbutler December 8, 2025 20:19 View session

Copilot AI requested a review from tylerbutler December 8, 2025 20:24

Copilot finished work on behalf of tylerbutler December 8, 2025 20:24

tylerbutler added 2 commits December 8, 2025 12:37

Merge branch 'main' into copilot/add-env-var-to-skip-version-output

ed1a8ae

Merge branch 'main' into copilot/add-env-var-to-skip-version-output

d56b57c

build

2cc6c31

Josmithr reviewed Dec 8, 2025

View reviewed changes

build-tools/packages/build-cli/src/test/commands/generate/typetests.test.ts Show resolved Hide resolved

feat(build-tools): add flag and environment variable to preserve version info in generated type tests #25988

Are you sure you want to change the base?

feat(build-tools): add flag and environment variable to preserve version info in generated type tests #25988

Conversation

Copilot AI commented Dec 4, 2025 • edited by tylerbutler Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Breaking Changes

Reviewer Guidance

Uh oh!

tylerbutler commented Dec 4, 2025

Uh oh!

tylerbutler commented Dec 4, 2025

Uh oh!

azure-pipelines bot commented Dec 4, 2025

Uh oh!

azure-pipelines bot commented Dec 4, 2025

Uh oh!

tylerbutler Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

tylerbutler commented Dec 4, 2025

Uh oh!

tylerbutler commented Dec 4, 2025

Uh oh!

azure-pipelines bot commented Dec 4, 2025

Uh oh!

azure-pipelines bot commented Dec 4, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

tylerbutler commented Dec 5, 2025

Uh oh!

Uh oh!

Uh oh!

tylerbutler commented Dec 8, 2025

Uh oh!

tylerbutler commented Dec 8, 2025

Uh oh!

azure-pipelines bot commented Dec 8, 2025

Uh oh!

azure-pipelines bot commented Dec 8, 2025

Uh oh!

tylerbutler commented Dec 8, 2025

Uh oh!

tylerbutler commented Dec 8, 2025

Uh oh!

azure-pipelines bot commented Dec 8, 2025

Uh oh!

azure-pipelines bot commented Dec 8, 2025

Uh oh!

Uh oh!

tylerbutler commented Dec 9, 2025

Uh oh!

tylerbutler commented Dec 9, 2025

Uh oh!

azure-pipelines bot commented Dec 9, 2025

Uh oh!

azure-pipelines bot commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Dec 4, 2025 •

edited by tylerbutler

Loading