Define storage for release note validation samples by danroth27 · Pull Request #10596 · dotnet/core

danroth27 · 2026-09-25T20:50:08Z

Summary

keep maintained release-note validation samples in release-notes/<major>.0/samples/<component>/
treat them as release-note verification fixtures, not substitutes for officially documented samples
upgrade component sample sets from preview to preview and start each major release fresh
use scratch projects only for one-off checks outside feature validation
read the exact SDK from the milestone's existing build-metadata.json
install that SDK in a scratch directory with the official dotnet-install script
verify the installed SDK matches build.sdk_version
build and run maintained samples for every release-note feature, including those without snippets; test any documented snippets as part of the samples
document preview-to-preview breaking changes and migration steps surfaced while upgrading maintained samples
record the last validated SDK in the top-level release-notes/<major>.0/samples/README.md
document each component's samples, run steps, and expected behavior in its README
define ownership, expected-result, and artifact guidance

Follow-up to #10516.

Validation

targeted markdownlint passed
links in both edited files passed markdown-link-check
git diff --check passed
full repository markdownlint still reports the existing releases.md blank-line error
full Prettier check reports the existing repository-wide formatting baseline
Checkov was unavailable because Python is not installed in this environment

Document versioned, component-owned validation samples in dotnet/core and retain scratch projects for one-off compile checks. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Keep upgrade coverage within a major release while avoiding copied scenarios between major versions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

State that the fixtures verify release notes and do not replace officially documented product samples. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot

Copilot review overview

🟡 Changes recommended

An unresolved moderate documentation conflict and a clarification nit remain.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1

Open (1)

Clarify documentation checks for committed release-note samples · New

What changed in this PR

Defines storage and maintenance conventions for release-note validation samples, with updated breaking-change guidance.

Changes:

Establishes per-major/component sample storage and lifecycle guidance.
Clarifies ownership, expected results, artifacts, and scratch-project usage.
Links breaking-change validation to maintained sample sets.

File	Summary
`.github/skills/validate-code-samples/SKILL.md`	Adds sample storage and maintenance guidance; includes one moderate documentation conflict and one nit requiring clarification.
`.github/skills/release-notes/references/format-template.md`	Updates breaking-change guidance to reference maintained sample sets.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Avoid implying that committed sample content is exempt from normal repository checks. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot

Copilot review overview

🟢 Approval recommended

No unresolved review issues were identified.

Review effort: Lite
Findings: None

Resolved since last review (1)

Clarify documentation checks for committed release-note samples

Use the existing build-metadata.json as the SDK source of truth and delegate scoped installation to the official dotnet-install script. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot

Copilot review overview

🟡 Changes recommended

Moderate SDK validation issues remain unresolved.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2

Open (2)

Use an isolated SDK installation directory for reproducible validation · New
Configure PATH or DOTNET_ROOT to use the installed SDK · New

Use fresh SDK directories and explicit version checks on Windows and POSIX; require build provenance to match the actual release-notes change set. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Use the product commit as the immutable change-set head and stop when the SDK and regenerated metadata cannot be aligned. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Verify the installed SDK matches build-metadata.json without requiring productCommit lineage or regeneration of release-notes artifacts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Keep the required version and installation safeguards while letting the validation workflow read JSON with its available tools. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot

Copilot review overview

🟡 Changes recommended

Critical validation gaps remain, along with branch and artifact guidance that needs clarification.

Review effort: Lite
Findings: 2

Open (2)

Restore VMR provenance validation for SDK builds · New
Retain explicit API, status, and semantics validation checks · New

Resolved since last review (2)

Configure PATH or DOTNET_ROOT to use the installed SDK
Use an isolated SDK installation directory for reproducible validation

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot

Copilot review overview

🟢 Approval recommended

The only finding is a minor nit, with no blocking issues.

Review effort: Lite
Findings: None

Resolved since last review (2)

Retain explicit API, status, and semantics validation checks
Restore VMR provenance validation for SDK builds

danroth27 marked this pull request as draft September 25, 2026 20:51

Start validation samples fresh for each major release

21d6246

Keep upgrade coverage within a major release while avoiding copied scenarios between major versions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

danroth27 marked this pull request as ready for review September 25, 2026 20:54

Clarify purpose of release note validation samples

5fb1290

State that the fixtures verify release notes and do not replace officially documented product samples. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

danroth27 requested review from BillWagner, KlausLoeffelmann, SamMonoRT, agocke, baronfel, davidortinau, jeffhandley, jongalloway, kotlarmilos, richlander and subhajitm and a lite review from Copilot September 25, 2026 21:00

Copilot started reviewing on behalf of danroth27 September 25, 2026 21:03 View session

Copilot AI reviewed Sep 25, 2026

View reviewed changes

Comment thread .github/skills/validate-code-samples/SKILL.md Outdated

Remove ambiguous sample validation guidance

69d6f84

Avoid implying that committed sample content is exempt from normal repository checks. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

danroth27 requested a lite review from Copilot September 25, 2026 21:51

Copilot started reviewing on behalf of danroth27 September 25, 2026 21:52 View session

Copilot AI reviewed Sep 25, 2026

View reviewed changes

danroth27 requested a lite review from Copilot September 25, 2026 23:38

Copilot started reviewing on behalf of danroth27 September 25, 2026 23:38 View session

Copilot AI reviewed Sep 25, 2026

View reviewed changes

Comment thread .github/skills/validate-code-samples/SKILL.md Outdated

Comment thread .github/skills/validate-code-samples/SKILL.md Outdated

danroth27 added 3 commits September 25, 2026 16:48

danroth27 added 9 commits September 25, 2026 17:14

Simplify release-note sample validation guidance

f5124b8

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Remove redundant per-sample SDK check

3d8b8ad

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Record last validated SDK with maintained samples

b56b365

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Track validated SDK in shared samples README

157424f

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Describe shared and component sample READMEs

4face29

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Focus sample validation on documented behavior and migrations

2a1807c

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Avoid conditioning migration guidance on draft notes

6581d6b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Validate every release-note feature with maintained samples

cc61d5e

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

danroth27 requested a lite review from Copilot September 26, 2026 01:48

Copilot started reviewing on behalf of danroth27 September 26, 2026 01:48 View session

Copilot AI reviewed Sep 26, 2026

View reviewed changes

Comment thread .github/skills/validate-code-samples/SKILL.md

Comment thread .github/skills/validate-code-samples/SKILL.md Outdated

Clarify observable behavior checks for release-note samples

30ccfe5

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

danroth27 requested a lite review from Copilot September 26, 2026 02:45

Copilot started reviewing on behalf of danroth27 September 26, 2026 02:46 View session

Copilot AI reviewed Sep 26, 2026

View reviewed changes

danroth27 mentioned this pull request Sep 26, 2026

Use incremental API diffs for preview migration guidance #10599

Merged

jongalloway approved these changes Sep 26, 2026

View reviewed changes

danroth27 mentioned this pull request Sep 26, 2026

[release-notes] .NET 11 RC 2 #10601

Draft

danroth27 merged commit ab40126 into main Sep 26, 2026
7 checks passed

danroth27 deleted the release-notes/code-sample-storage branch September 26, 2026 19:40

Navigation Menu

Repository navigation

Define storage for release note validation samples - #10596

Define storage for release note validation samples#10596
danroth27 merged 18 commits into
mainfrom
release-notes/code-sample-storage

danroth27 commented Sep 25, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

danroth27 commented Sep 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟢 Approval recommended

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟢 Approval recommended

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

danroth27 commented Sep 25, 2026 •

edited

Loading