Beta Break Process

Beta | Legacy Breaks for FF Client

Beta and Legacy+Beta APIs are both used in production by partners and not settled/finalized. They are supported under an agreement that allows them to be carefully changed ahead of major version bumps. New deprecations should follow API Deprecation leveraging the table below to schedule removal.

Create Issue for Existing Deprecation

If the API deprecation does not have an issue per API Deprecation (preferred), use these steps to track without duplicating a lot of information.

1. Search partner repositories yourself or have Fluid Framework team member do so. See partner info (Microsoft internal).

2. Go to applicable issue from table:

   Version	Conditions	Tracking Issue
   2.60	- non-@legacy deprecations merging before 2.52 branch OR - unused +@legacy deprecations merging before 2.52 branch	Client 2.60 Beta | Legacy Breaking Changes · Issue #24412
   2.70	- non-@legacy deprecations (merge before 2.62 branch) OR - used +@legacy deprecations merged before 2.52 branch OR - unused +@legacy deprecations merging before 2.62 branch	Client 2.70 Beta | Legacy Breaking Changes · Issue #24878
   2.80	otherwise (used +@legacy deprecations merging before 2.62 branch)	Client 2.80 Beta | Legacy Breaking Changes · Issue #

   When in doubt if a @legacy API or pattern is in use, assume that it is in use and allow three months (12 weeks) before breaking.

3. Add sub-issue

   

4. Use Breaking Change template

   

   1. Use information in the existing release notes (or pending changeset of deprecation) to fill out the issue. Focus on conveying the change to customers.
   2. Set Assignee to whomever is expected to complete the work (ideally also a good contact for any questions)
   3. Create the issue.

5. Ideally associate a PR that does the removal. See API Deprecation "Beta / Legacy staging" for steps.