Skip to content

Added instructions for identifying changes specific to a subset of TFMs and OSes, where applicable.#4243

Open
paulmedynski wants to merge 2 commits intomainfrom
dev/paul/pr-prompt
Open

Added instructions for identifying changes specific to a subset of TFMs and OSes, where applicable.#4243
paulmedynski wants to merge 2 commits intomainfrom
dev/paul/pr-prompt

Conversation

@paulmedynski
Copy link
Copy Markdown
Contributor

@paulmedynski paulmedynski commented Apr 28, 2026

Summary

Enhances the release-notes prompt with explicit guidance for identifying and annotating changes that only affect a subset of the driver's supported targets.

Changes

New Step 2.1 — TFM Scope Detection

Instructs the agent to examine each PR's changed files and code for framework-specific evidence before writing release notes:

  • File suffixes: .netfx.cs, .netcore.cs
  • Conditional compilation: #if NETFRAMEWORK, #if NET
  • MSBuild Condition expressions on TargetFramework / TargetFrameworks

When a change is framework-scoped, the generated note includes a concise qualifier such as (net462 only) or (net8.0/net9.0 only). Universal changes get no qualifier.

New Step 2.2 — OS Scope Detection

Mirrors Step 2.1 for operating-system-specific changes:

  • File suffixes: .windows.cs, .unix.cs
  • Preprocessor symbols: #if _WINDOWS, #if _UNIX
  • MSBuild TargetOs / NormalizedTargetOs conditions
  • Native vs managed SNI path gates

When a change is OS-scoped, the note includes a qualifier such as (Windows only) or (Unix only). When both TFM and OS are scoped they are combined: e.g. (net8.0/net9.0 on Windows only).

Updated Step 5.2 — Generation Requirement

The release-notes writing step now explicitly requires TFM and OS qualifiers to be included for any Added/Changed/Fixed/Removed item where Step 2.1 or Step 2.2 identifies non-universal scope.

Checklist

  • Tests added or updated — N/A (prompt-only change)
  • Public API changes documented — N/A
  • No breaking changes introduced

Copilot AI review requested due to automatic review settings April 28, 2026 16:17
@github-project-automation github-project-automation Bot moved this to To triage in SqlClient Board Apr 28, 2026
@paulmedynski paulmedynski added this to the 7.1.0-preview2 milestone Apr 28, 2026
@paulmedynski paulmedynski moved this from To triage to In progress in SqlClient Board Apr 28, 2026
@paulmedynski paulmedynski marked this pull request as ready for review April 28, 2026 16:19
@paulmedynski paulmedynski requested a review from a team as a code owner April 28, 2026 16:19
@paulmedynski paulmedynski moved this from In progress to In review in SqlClient Board Apr 28, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the release-notes generation prompt to explicitly guide how to identify and annotate changes that only apply to certain Target Frameworks (TFMs) and/or operating systems, based on source-level evidence.

Changes:

  • Adds instructions to determine per-PR TFM scope using file naming, conditional compilation, and build conditions.
  • Adds instructions to determine per-PR OS scope using file naming, preprocessor symbols, and OS-gated build logic.
  • Updates the release-notes writing instructions to include TFM/OS qualifiers when changes are not universal across supported targets.

Comment thread .github/prompts/release-notes.prompt.md Outdated
Comment thread .github/prompts/release-notes.prompt.md Outdated
mdaigle
mdaigle previously approved these changes Apr 28, 2026
cheenamalhotra
cheenamalhotra previously approved these changes Apr 29, 2026
apoorvdeshmukh
apoorvdeshmukh previously approved these changes Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

6 participants