Skip to content

[release-notes] Add component index links with component PRs - #10615

Merged
danroth27 merged 5 commits into
mainfrom
release-notes/preallocated-index-links
Sep 27, 2026
Merged

danroth27 merged 5 commits into
mainfrom
release-notes/preallocated-index-links

Conversation

@danroth27

Copy link
Copy Markdown
Member

Summary

Preallocate unlinked component entries in each release milestone's base README. When a component PR adds its note (and any maintained validation samples), it also links only its own entry. The base index remains link-valid as it grows; each component PR remains responsible for its own note and index link. Once every component merges, verify all expected links and replace the draft introduction before publication.

This updates the release-notes, format-template, PR-layout, and incremental-rerun guidance. Push and PR markdown link checks remain enabled, unchanged. The layout is already being applied to the .NET 11 RC 2 draft set (#10601 through #10614); this PR changes only future workflow guidance and is based directly on main without the scratch skills overlay or RC2 release artifacts.

Preallocate unlinked entries on the milestone base branch, then let each component PR link only its own file. Keep base and component branches link-valid for both push and PR checks, and verify the complete index before publication.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Workflow orchestration and the Visual Basic template entry must be corrected.

Review effort: Lite
Findings: 1 High severity

Open (1)
What changed in this PR

Updates .NET release-note guidance for preallocated component indexes and per-component README links.

Changes:

  • Defines base/component branch ownership and rerun behavior.
  • Revises layouts, templates, and completion checks.
  • Adds staged link and merge verification guidance.
File Summary
.github/​skills/​update-existing-branch/​SKILL.md Updates incremental branch and README-link ownership guidance.
.github/​skills/​release-notes/​SKILL.md Critical: Workflow orchestration still describes the old single-PR flow and insufficient output limit (4 votes).
.github/​skills/​release-notes/​references/​pr-layout.md Documents base/component branch responsibilities and link invariants.
.github/​skills/​release-notes/​references/​format-template.md Moderate: Unconditionally includes the optional Visual Basic entry (1 vote).

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

Comment thread .github/skills/release-notes/SKILL.md
Describe the index-entry change for any component instead of singling out Libraries.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Resolve the template and component-mapping inconsistencies before approval.

Review effort: Lite
Findings: 1 Low severity

Open (1)
Resolved since last review (1)

Comment thread .github/skills/release-notes/references/format-template.md Outdated
Use reader-facing wording from the start, remove the default optional Visual Basic entry, and let component PRs supply only their own links.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

An unresolved moderate issue affects incremental rerun handling, and mapping guidance also requires alignment.

Review effort: Lite
Findings: 1 Medium severity

Open (1)
Resolved since last review (1)

Comment thread .github/skills/release-notes/references/format-template.md Outdated
Keep the planned component set fixed and send noteworthy VB changes to the language owner for editorial review instead of generating an optional output file.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Clarify the destination and index handling for Visual Basic release-note content.

Review effort: Lite
Findings: 1 Medium severity

Open (1)
Resolved since last review (1)

Comment thread .github/skills/release-notes/references/component-mapping.md Outdated
Keep Roslyn mapped to C# alone and require out-of-band stub PRs to merge so every preallocated index entry has a matching file.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 637615df-deba-4407-bf00-9a3bd4e569b5

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Retain the Visual Basic component mapping and preallocated README entry.

Review effort: Lite
Findings: 1 Medium severity

Open (1)
Resolved since last review (1)
Previously missed (1)

In code that hasn't changed since last review

Medium severity Keep the Visual Basic placeholder in the release-notes template

.github/​skills/​release-notes/​references/​format-template.md:61

This template now omits the Visual Basic placeholder, although existing milestone indexes include visualbasic.md even for previews with no new VB features (release-notes/11.0/preview/preview1/README.md:10-14). A base README generated from this template would therefore never preallocate or later link the Visual Basic note; keep an unlinked Visual Basic entry under Languages.

Comment thread .github/skills/release-notes/references/component-mapping.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

No unresolved blocking issues were identified.

Review effort: Lite
Findings: None

Resolved since last review (1)

@danroth27
danroth27 merged commit 16662fd into main Sep 27, 2026
8 checks passed
@danroth27
danroth27 deleted the release-notes/preallocated-index-links branch September 27, 2026 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants