-
Notifications
You must be signed in to change notification settings - Fork 317
Add 7.0.0-preview3 release notes and release note generation prompt. #3829
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
+342
−0
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
9d63ccc
Add release notes and prompt.
mdaigle 62f28ed
Update prompt.
mdaigle ffed4ef
Add release notes template file.
mdaigle 3417bb7
Clean slate
mdaigle 79c5679
Regenerate files.
mdaigle 7e5398d
Clean up notes.
mdaigle 8f82317
Remove minor changes from notes.
mdaigle c83516b
Remove old prompt.
mdaigle 12dc2d1
Review changes.
mdaigle 6f860eb
Minor updates from copilot.
mdaigle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| # Release Notes | ||
|
|
||
| ## Preview Release 7.0.0-preview3 - 2025-12-05 | ||
|
|
||
| ## Changes Since [7.0.0-preview2](7.0.0-preview2.md) | ||
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| This update brings the following changes since the [7.0.0-preview2](7.0.0-preview2.md) release: | ||
|
|
||
mdaigle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Added | ||
|
|
||
| #### Added support for .NET 10 | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Added support for .NET 10 by updating package references and enabling multi-targeting in test projects. This change was introduced in PR [#3686](https://github.com/dotnet/SqlClient/pull/3686). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Developers targeting .NET 10. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Users can now build and run applications using Microsoft.Data.SqlClient on .NET 10. | ||
|
|
||
| #### Enabled User Agent Extension | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Enabled the User Agent Extension feature, allowing pre-calculated JSON payloads to be added to feature extension data and handling server acknowledgments. This change was introduced in PR [#3606](https://github.com/dotnet/SqlClient/pull/3606). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Users utilizing the User Agent Extension feature for telemetry or tracking. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Enhanced telemetry and tracking capabilities with the User Agent Extension. | ||
|
|
||
| ### Fixed | ||
|
|
||
| #### Fixed an issue with extra connection deactivation in `PutObjectFromTransactedPool` | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Removed an extraneous connection deactivation call in `PutObjectFromTransactedPool` that was causing active connection counts to go negative. This fix was introduced in PR [#3758](https://github.com/dotnet/SqlClient/pull/3758). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Users using distributed transactions. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Fixes an issue where active connection counts could become incorrect when using distributed transactions. | ||
|
|
||
| ### Changed | ||
|
|
||
| #### Enabled `SqlClientDiagnosticListener` in `SqlCommand` on .NET Framework | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Enabled `SqlClientDiagnosticListener` in `SqlCommand` for .NET Framework applications. This change was introduced in PR [#3658](https://github.com/dotnet/SqlClient/pull/3658). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Developers using .NET Framework who need diagnostic information from `SqlCommand`. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - `SqlCommand` execution will now emit diagnostic events on .NET Framework, consistent with .NET Core. | ||
|
|
||
| #### Performance improvements in `decimal.GetBits` usage and Always Encrypted primitives | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Optimized `decimal.GetBits` usage to reduce allocations on .NET 5+ and used lower-allocation primitives for Always Encrypted in `SqlColumnEncryptionCertificateStoreProvider`. These changes were introduced in PRs [#3732](https://github.com/dotnet/SqlClient/pull/3732) and [#3660](https://github.com/dotnet/SqlClient/pull/3660). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Applications using `decimal` types or Always Encrypted with certificate store providers. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Reduced memory allocations and improved performance for supported scenarios. | ||
|
|
||
| #### Enabled NuGet audit on all builds | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Enabled implicit NuGet audits on all builds to detect vulnerabilities in dependencies. This change was introduced in PR [#3713](https://github.com/dotnet/SqlClient/pull/3713). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Developers and users concerned with security and supply chain vulnerabilities. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Builds will now fail if vulnerabilities are detected in dependencies, ensuring a more secure codebase. | ||
|
|
||
| #### Code cleanup and refactoring | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Various code cleanup and refactoring tasks, including removing unused members, merging classes, and improving code health. These changes were introduced in PRs [#3803](https://github.com/dotnet/SqlClient/pull/3803), [#3781](https://github.com/dotnet/SqlClient/pull/3781), [#3760](https://github.com/dotnet/SqlClient/pull/3760), [#3746](https://github.com/dotnet/SqlClient/pull/3746), [#3743](https://github.com/dotnet/SqlClient/pull/3743), [#3738](https://github.com/dotnet/SqlClient/pull/3738), [#3683](https://github.com/dotnet/SqlClient/pull/3683), and [#3676](https://github.com/dotnet/SqlClient/pull/3676). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Contributors and maintainers of the codebase. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Improved code maintainability and readability. No functional changes expected. | ||
|
|
||
| #### Test infrastructure updates | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Updates to test infrastructure, including enabling previously disabled tests and disabling flaky tests. These changes were introduced in PRs [#3750](https://github.com/dotnet/SqlClient/pull/3750), [#3823](https://github.com/dotnet/SqlClient/pull/3823), and [#3712](https://github.com/dotnet/SqlClient/pull/3712). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - Contributors and maintainers. | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Improved test reliability and coverage. | ||
|
|
||
| #### Updated version variables for release | ||
|
|
||
| *What Changed:* | ||
|
|
||
| - Updated version variables for the 7.0.0-preview3 release. This change was introduced in PR [#3825](https://github.com/dotnet/SqlClient/pull/3825). | ||
|
|
||
| *Who Benefits:* | ||
|
|
||
| - N/A | ||
|
|
||
| *Impact:* | ||
|
|
||
| - Ensures correct versioning for the release. | ||
|
|
||
| ## Contributors | ||
|
|
||
| We thank the following public contributors. Their efforts toward this project are very much appreciated. | ||
|
|
||
| - [edwardneal](https://github.com/edwardneal) | ||
|
|
||
| ## Target Platform Support | ||
|
|
||
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - .NET Framework 4.6.2+ (Windows x86, Windows x64, Windows ARM64) | ||
| - .NET 8.0+ (Windows x86, Windows x64, Windows ARM, Windows ARM64, Linux, macOS) | ||
|
|
||
| ### Dependencies | ||
|
|
||
| #### .NET Framework 4.6.2+ | ||
|
|
||
| - Azure.Core 1.49.0 | ||
mdaigle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Azure.Identity 1.16.0 | ||
| - Microsoft.Bcl.Cryptography 8.0.0 | ||
| - Microsoft.Data.SqlClient.SNI 6.0.2 | ||
| - Microsoft.Extensions.Caching.Memory 8.0.1 | ||
| - Microsoft.IdentityModel.JsonWebTokens 8.14.0 | ||
| - Microsoft.IdentityModel.Protocols.OpenIdConnect 8.14.0 | ||
| - System.Buffers 4.6.1 | ||
| - System.Diagnostics.DiagnosticSource 8.0.1 | ||
| - System.Memory 4.6.3 | ||
| - System.Runtime.InteropServices.RuntimeInformation 4.3.0 | ||
| - System.Security.Cryptography.Pkcs 8.0.1 | ||
| - System.Text.Json 8.0.6 | ||
| - System.Threading.Channels 8.0.0 | ||
| - System.ValueTuple 4.6.1 | ||
|
|
||
| #### .NET 8.0 | ||
|
|
||
| - Azure.Core 1.49.0 | ||
| - Azure.Identity 1.16.0 | ||
| - Microsoft.Bcl.Cryptography 8.0.0 | ||
| - Microsoft.Data.SqlClient.SNI.runtime 6.0.2 | ||
| - Microsoft.Extensions.Caching.Memory 8.0.1 | ||
| - Microsoft.IdentityModel.JsonWebTokens 8.14.0 | ||
| - Microsoft.IdentityModel.Protocols.OpenIdConnect 8.14.0 | ||
| - Microsoft.SqlServer.Server 1.0.0 | ||
| - System.Configuration.ConfigurationManager 8.0.1 | ||
| - System.Security.Cryptography.Pkcs 8.0.1 | ||
|
|
||
| #### .NET 9.0 | ||
|
|
||
| - Azure.Core 1.49.0 | ||
| - Azure.Identity 1.16.0 | ||
| - Microsoft.Bcl.Cryptography 9.0.9 | ||
| - Microsoft.Data.SqlClient.SNI.runtime 6.0.2 | ||
| - Microsoft.Extensions.Caching.Memory 9.0.9 | ||
| - Microsoft.IdentityModel.JsonWebTokens 8.14.0 | ||
| - Microsoft.IdentityModel.Protocols.OpenIdConnect 8.14.0 | ||
| - Microsoft.SqlServer.Server 1.0.0 | ||
| - System.Configuration.ConfigurationManager 9.0.9 | ||
| - System.Security.Cryptography.Pkcs 9.0.9 | ||
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # Generate Release Notes | ||
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| This prompt guides the AI to generate release notes for a specific milestone of the Microsoft.Data.SqlClient project. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - The user must provide the **Milestone Name** (e.g., `7.0.0-preview3`). | ||
| - The user should specify if this is a preview or stable release if it's not obvious from the milestone name. | ||
|
|
||
| ## Workflow Steps | ||
|
|
||
| 1. **Fetch Milestone Items**: | ||
| - Search for all **merged** Pull Requests associated with the specified milestone in the `dotnet/SqlClient` repository. | ||
| - Use `mcp_github_search_issues` with query `is:pr is:merged milestone:"<Milestone Name>" repo:dotnet/SqlClient`. | ||
|
|
||
| 2. **Analyze and Categorize**: | ||
| - Review the title and body of each PR. | ||
| - Categorize them into: `Added`, `Fixed`, `Changed`, `Removed`, etc. | ||
| - Identify the contributors for the "Contributors" section. | ||
|
|
||
| 3. **Draft Release Notes Content**: | ||
| - **Header**: `# Release Notes` followed by `## <Release Type> Release <Version> - <Date>`. | ||
| - **Changes Link**: `## Changes Since [<Previous Version>](<Previous Version>.md)`. | ||
| - **Items**: For each categorized item, generate a detailed entry: | ||
| - **Title**: The PR title or a summarized version. | ||
| - **Link**: Link to the PR `([#<PR Number>](<PR URL>))`. | ||
| - **Details**: | ||
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - `*What Changed:*`: A brief description of the technical change. | ||
| - `*Who Benefits:*`: The target audience (e.g., Developers using feature X). | ||
| - `*Impact:*`: The effect on the application (e.g., Performance improvement, Bug fix). | ||
| - **Contributors**: List public contributors (excluding core team if possible, or list all non-bot contributors). | ||
| - **Target Platform Support**: | ||
| - Check `README.md` or project files for current support. | ||
| - List supported .NET Framework and .NET Core/.NET versions and OSs. | ||
| - **Dependencies**: | ||
| - Analyze `Directory.Packages.props` and `src/**/*.csproj` files to list dependencies for each target framework (.NET Framework, .NET Core/Standard). | ||
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Group them by target framework (e.g., .NET Framework 4.6.2+, .NET 8.0, .NET 9.0). | ||
mdaigle marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 4. **Create Release Notes File**: | ||
| - Determine the correct path: `release-notes/<Major.Minor>/<Version>.md`. | ||
| - Create the file with the drafted content. | ||
|
|
||
| 5. **Update CHANGELOG.md**: | ||
| - Add a new entry at the top of the list (under the Note). | ||
| - Format: `## [<Release Type> Release <Version>] - <Date>`. | ||
| - Include the "Changes Since..." text and the categorized items (Added, Fixed, Changed). | ||
| - *Note*: You can omit the detailed "What Changed/Who Benefits/Impact" sections in the Changelog to keep it concise, or include them if requested. The previous pattern suggests including the full details or a summary. *Follow the existing pattern in CHANGELOG.md*. | ||
|
|
||
| 6. **Update Release Directory README**: | ||
| - Update `release-notes/<Major.Minor>/README.md`. | ||
| - Add the new release to the table: `| <Date> | <Version> | [Release Notes](<Version>.md) |`. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| "Generate release notes for milestone 7.0.0-preview3." | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.