-
Notifications
You must be signed in to change notification settings - Fork 549
Tree's enum schema utility are now beta #24749
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.
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
Conversation
There was a problem hiding this 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 three tree schema utilities—singletonSchema
, adaptEnum
, and enumFromStrings
—from the alpha to beta stability channel across Fluid Framework and the DDS tree package.
- Change stability annotations from
@alpha
to@beta
in source and generated API reports - Bump package versions for
fluid-framework
and@fluidframework/tree
to minor - Update ChangeSet to note the beta promotion
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md | Adds beta annotations for schema utilities |
packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md | Retags alpha entries to beta (should be removed instead) |
packages/dds/tree/src/util/typeUtils.ts | Updates JSDoc tags for utility types to beta |
packages/dds/tree/src/simple-tree/api/schemaCreationUtilities.ts | Updates JSDoc tags for schema helpers to beta |
packages/dds/tree/api-report/tree.beta.api.md | Adds beta annotations for schema utilities |
packages/dds/tree/api-report/tree.alpha.api.md | Retags alpha entries to beta (should be removed instead) |
.changeset/every-cases-enjoy.md | ChangeSet bump for minor version and section notes |
Comments suppressed due to low confidence (2)
packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md:7
- Entries for
adaptEnum
(and the other promoted utilities) should be removed from the alpha API report rather than simply retagged to beta. Alpha report files should only list APIs still in alpha.
// @beta
packages/dds/tree/api-report/tree.alpha.api.md:7
- Entries for
adaptEnum
,enumFromStrings
,singletonSchema
,PopUnion
, andUnionToTuple
now in beta should be removed from the alpha API report rather than retagged. This file should only expose APIs still marked alpha.
// @beta
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
Description
The functions singletonSchema, adaptEnum and enumFromStrings are now
@beta
instead of@alpha
.Reviewer Guidance
The review process is outlined on this wiki page.