Promote snapshotSchemaCompatibility to beta#26288
Promote snapshotSchemaCompatibility to beta#26288CraigMacomber merged 18 commits intomicrosoft:mainfrom
Conversation
There was a problem hiding this comment.
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
@alphato@betaforcheckSchemaCompatibilitySnapshots,SchemaCompatibilitySnapshotsOptions, andSnapshotFileSystem - Updated API reports to include these APIs in beta exports
- Updated example code to import from beta instead of alpha paths
- Replaced
TreeViewConfigurationAlphausage withTreeViewConfigurationin 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 |
packages/dds/tree/src/simple-tree/api/snapshotCompatibilityChecker.ts
Outdated
Show resolved
Hide resolved
Josmithr
left a comment
There was a problem hiding this comment.
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.
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
|
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. |
## Description A collection of improvements split out from #26288 which were made based on the API review of checkSchemaCompatibilitySnapshots.
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Description
Promote snapshotSchemaCompatibility to beta.
Reviewer Guidance
The review process is outlined on this wiki page.