Skip to content

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

Merged
merged 2 commits into from
Jun 11, 2025

Conversation

CraigMacomber
Copy link
Contributor

Description

The functions singletonSchema, adaptEnum and enumFromStrings are now @beta instead of @alpha.

Reviewer Guidance

The review process is outlined on this wiki page.

@Copilot Copilot AI review requested due to automatic review settings June 2, 2025 20:24
@CraigMacomber CraigMacomber requested review from a team as code owners June 2, 2025 20:24
@github-actions github-actions bot added area: dds Issues related to distributed data structures area: dds: tree area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct changeset-present public api change Changes to a public API base: main PRs targeted against main branch labels Jun 2, 2025
Copy link
Contributor

@Copilot 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 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, and UnionToTuple now in beta should be removed from the alpha API report rather than retagged. This file should only expose APIs still marked alpha.
// @beta

Copy link
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:
  222981 links
    1707 destination URLs
    1939 URLs ignored
       0 warnings
       0 errors


@CraigMacomber CraigMacomber merged commit a23bc9e into microsoft:main Jun 11, 2025
38 checks passed
@CraigMacomber CraigMacomber deleted the enum branch June 11, 2025 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: dds: tree area: dds Issues related to distributed data structures area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch changeset-present public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants