Skip to content

Promote snapshotSchemaCompatibility to beta#26288

Merged
CraigMacomber merged 18 commits intomicrosoft:mainfrom
CraigMacomber:betaCompat
Feb 24, 2026
Merged

Promote snapshotSchemaCompatibility to beta#26288
CraigMacomber merged 18 commits intomicrosoft:mainfrom
CraigMacomber:betaCompat

Conversation

@CraigMacomber
Copy link
Copy Markdown
Contributor

@CraigMacomber CraigMacomber commented Jan 26, 2026

Description

Promote snapshotSchemaCompatibility to beta.

Reviewer Guidance

The review process is outlined on this wiki page.

@CraigMacomber CraigMacomber requested review from a team as code owners January 26, 2026 21:45
Copilot AI review requested due to automatic review settings January 26, 2026 21:45
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

This PR promotes the checkSchemaCompatibilitySnapshots function and related interfaces (SchemaCompatibilitySnapshotsOptions and SnapshotFileSystem) from alpha to beta stability level.

Changes:

  • Updated JSDoc tags from @alpha to @beta for checkSchemaCompatibilitySnapshots, SchemaCompatibilitySnapshotsOptions, and SnapshotFileSystem
  • Updated API reports to include these APIs in beta exports
  • Updated example code to import from beta instead of alpha paths
  • Replaced TreeViewConfigurationAlpha usage with TreeViewConfiguration in example code

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/framework/fluid-framework/api-report/fluid-framework.legacy.beta.api.md Adds beta exports for the promoted APIs
packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md Adds beta exports for the promoted APIs
packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md Updates API tags from alpha to beta
packages/dds/tree/src/simple-tree/api/snapshotCompatibilityChecker.ts Updates JSDoc tags from @alpha to @beta
packages/dds/tree/api-report/tree.legacy.beta.api.md Adds beta exports for the promoted APIs
packages/dds/tree/api-report/tree.beta.api.md Adds beta exports for the promoted APIs
packages/dds/tree/api-report/tree.alpha.api.md Updates API tags from alpha to beta
examples/data-objects/inventory-app/src/test/inventoryApp.test.tsx Updates import from alpha to beta
examples/apps/tree-cli-app/src/utils.ts Reorganizes imports to use beta for promoted types
examples/apps/tree-cli-app/src/test/schema.spec.ts Updates import from alpha to beta
examples/apps/tree-cli-app/src/schema.ts Switches from TreeViewConfigurationAlpha to TreeViewConfiguration
.changeset/short-eyes-give.md Documents the promotion and provides usage example

Copy link
Copy Markdown
Contributor

@Josmithr Josmithr left a comment

Choose a reason for hiding this comment

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

Left a couple of suggestions for the changeset docs. Mainly, I think it would be worth adding documentation for the sample workflow being accomplished by the test code sample, including sample package.json scripts.

CraigMacomber and others added 2 commits January 26, 2026 15:06
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
@CraigMacomber CraigMacomber requested a review from noencke January 26, 2026 23:11
@CraigMacomber
Copy link
Copy Markdown
Contributor Author

It was decided that this APi needs some improvements for cases which do not explicitly version their releases to help reduce the risk of overwriting snapshots and to generally be more ergonomic in such cases. I'll make a different PR to land the improvements other than beta promotion from this.

@CraigMacomber CraigMacomber marked this pull request as draft February 3, 2026 18:50
CraigMacomber added a commit that referenced this pull request Feb 12, 2026
## Description

A collection of improvements split out from
#26288 which were made
based on the API review of checkSchemaCompatibilitySnapshots.
@CraigMacomber CraigMacomber marked this pull request as ready for review February 12, 2026 23:14
@CraigMacomber CraigMacomber changed the title Promote checkSchemaCompatibilitySnapshots to beta Promote snapshotSchemaCompatibility to beta Feb 24, 2026
@CraigMacomber CraigMacomber enabled auto-merge (squash) February 24, 2026 17:21
@github-actions
Copy link
Copy Markdown
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  257789 links
    1822 destination URLs
    2063 URLs ignored
       0 warnings
       0 errors


@CraigMacomber CraigMacomber merged commit eb4ef62 into microsoft:main Feb 24, 2026
39 checks passed
@CraigMacomber CraigMacomber deleted the betaCompat branch February 24, 2026 18:12
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.

4 participants