Ensure sql-api-docs are generated#4049
Merged
cheenamalhotra merged 1 commit intomainfrom Mar 13, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the SqlClient Extensions packaging projects to generate XML documentation in the standard SDK output location so it’s automatically included in produced NuGet packages and available for downstream docs generation.
Changes:
- Replaced custom
<DocumentationFile>output paths with<GenerateDocumentationFile>true</GenerateDocumentationFile>in Extensions projects. - Updated in-file comments to reflect the intended SDK/pack behavior for XML docs inclusion.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Microsoft.Data.SqlClient.Extensions/Azure/src/Azure.csproj | Enables SDK-style XML doc generation so the XML lands next to the built assembly and is picked up during packing. |
| src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj | Same as above, aligning Abstractions with the SDK default XML doc generation/packing behavior. |
You can also share your feedback on Copilot code review. Take the survey.
paulmedynski
approved these changes
Mar 13, 2026
cheenamalhotra
approved these changes
Mar 13, 2026
This was referenced Mar 18, 2026
This was referenced Mar 18, 2026
Open
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.
Description
This commit ensures that xml documentation file for new packages is generated correctly.
Issues
AB#42430
Testing
Artifacts from the pipeline will be validated.
Locally all NuGet packages contain the xml.
Guidelines
Please review the contribution guidelines before submitting a pull request: