Add preview disclaimer to WSLC SDK header and NuGet package#40153
Open
benhillis wants to merge 1 commit intomicrosoft:feature/wsl-for-appsfrom
Open
Add preview disclaimer to WSLC SDK header and NuGet package#40153benhillis wants to merge 1 commit intomicrosoft:feature/wsl-for-appsfrom
benhillis wants to merge 1 commit intomicrosoft:feature/wsl-for-appsfrom
Conversation
Add preview notice to wslcsdk.h header comment block, NuGet README, and nuspec description to clearly communicate that the WSLC SDK API is subject to breaking changes during the preview period. Also fix incorrect header filename reference in README (WSLCApi.h -> wslcsdk.h). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds clear “preview / breaking changes” disclaimers to the WSLC SDK’s public-facing surfaces (header + NuGet package metadata/docs) to set expectations about API stability during the preview period.
Changes:
- Added a preview notice block to the top-of-file comment in
wslcsdk.h. - Added a preview disclaimer to the NuGet package README.
- Updated the NuGet
.nuspec.indescription to explicitly mark the SDK as preview and subject to breaking changes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/windows/WslcSDK/wslcsdk.h | Adds a preview disclaimer in the public SDK header banner comment. |
| nuget/Microsoft.WSL.Containers/docs/README.MD | Adds a preview disclaimer and updates the referenced header name. |
| nuget/Microsoft.WSL.Containers.nuspec.in | Updates package description to include preview/breaking-change notice. |
Comment on lines
+13
to
+16
| PREVIEW NOTICE: This API is currently in preview and is subject to breaking | ||
| changes in future releases without prior notice. Do not rely on API stability | ||
| for production workloads. Features, function signatures, and behaviors may | ||
| change between releases during the preview period. |
There was a problem hiding this comment.
While updating the header banner, consider also correcting the "Module Name" field above: it currently says "WslcSDK.h" but the file is "wslcsdk.h". Keeping these consistent avoids confusion for SDK consumers and when searching for the header referenced in the NuGet package.
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
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.
Add preview notice to communicate that the WSLC SDK API is subject to breaking changes during the preview period.
Changes:
wslcsdk.h: Add PREVIEW NOTICE block to the header commentMicrosoft.WSL.Containers.nuspec.in: Update description to include "(Preview - API subject to breaking changes)"