build: Update API-Extractor report configurations to include @legacy and @system in API reports#24439
Merged
Josmithr merged 9 commits intomicrosoft:mainfrom Apr 24, 2025
Conversation
github-actions
bot
added
area: build
github-actions
bot
removed
area: dds: propertydds
area: examples
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the API-Extractor report configurations by adding the @legacy annotation to various API report comments, ensuring that breaking-change implications for legacy APIs are clearly indicated.
- Consistently adds "@legacy" to all relevant @Alpha and @Alpha @deprecated annotations.
- Ensures that the API report files now clearly mark legacy API items, which aids code reviewers in assessing potential breaking changes.
Reviewed Changes
Copilot reviewed 59 out of 61 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/dds/task-manager/api-report/task-manager.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/shared-summary-block/api-report/shared-summary-block.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/shared-object-base/api-report/shared-object-base.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/sequence/api-report/sequence.legacy.alpha.api.md | Added "@legacy" to all @Alpha and @Alpha @deprecated annotations. |
| packages/dds/register-collection/api-report/register-collection.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/ordered-collection/api-report/ordered-collection.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/merge-tree/api-report/merge-tree.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/matrix/api-report/matrix.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/map/api-report/map.legacy.public.api.md | Added "@legacy" to all @public annotations. |
| packages/dds/map/api-report/map.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/dds/counter/api-report/counter.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/common/driver-definitions/api-report/driver-definitions.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/common/core-utils/api-report/core-utils.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/common/core-interfaces/api-report/core-interfaces.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/common/container-definitions/api-report/container-definitions.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| packages/common/client-utils/api-report/client-utils.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| experimental/dds/tree/api-report/experimental-tree.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
| azure/packages/azure-service-utils/api-report/azure-service-utils.legacy.alpha.api.md | Added "@legacy" to all @Alpha annotations. |
Files not reviewed (2)
- common/build/build-common/api-extractor-base.json: Language not supported
- common/build/build-common/api-extractor-report-base.esm.json: Language not supported
Josmithr
changed the title
@legacy and @system in API reports@legacy and @system in API reports
noencke
approved these changes
Apr 23, 2025
The relevant properties are already extended via `api-extractor-base.json`
jason-ha
approved these changes
Apr 23, 2025
Contributor
jason-ha
left a comment
jason-ha
left a comment
There was a problem hiding this comment.
Nice - especially system
jason-ha
approved these changes
Apr 23, 2025
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
markfields
pushed a commit
to markfields/FluidFramework
that referenced
this pull request
Apr 24, 2025
…` and `@system` in API reports (microsoft#24439) Both `@legacy` and `@system` have breaking change implications, so including them in our API reports will offer useful context in code reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Both
@legacyand@systemhave breaking change implications, so including them in our API reports will offer useful context in code reviews.