Capture preview API changes in the release-notes skill#10473
Open
danroth27 wants to merge 1 commit into
Open
Conversation
Preview release notes are an upgrade guide from the previous preview, so preview-to-preview API renames/reshapes/removals must be documented as migration notes. Add explicit guidance distinguishing them from breaking changes: - editorial-rules.md: new 'Preview API changes vs. breaking changes' section (dedicated section, reserve Breaking changes for version-to-version breaks, new default behavior is a feature, check earlier previews for renames). - format-template.md: add a 'Preview API changes' section to the template and update the section rule. - api-verification.md: new 'Capturing preview API changes' section describing the previous-preview -> current-preview API diff. - changes-schema.md: note that breaking_changes: true also covers preview API changes, routed to the Preview API changes section. - SKILL.md: mention preview-API-change capture in the pipeline. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Member
|
@danroth27 I'd really like to get Automate public API diff reports for in-development .NET releases (#10469) merged before we merge this; there is some overlap here. |
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
2 participants
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.
What
Updates the
release-notesskill so preview-to-preview API changes (renames, reshapes, removals of APIs that haven''t shipped in a stable release) are captured and documented as migration notes, instead of being missed or mislabeled as breaking changes.Motivated by the .NET 11 Preview 6 notes:
EnvironmentBoundary(documented in Preview 1) was renamed toEnvironmentViewin Preview 6, and the automatic CSRF default was initially framed as a breaking change. Preview notes are an upgrade guide from the previous preview, so these renames need migration notes — but a preview-to-preview rename is not a "breaking change" (nothing stable shipped yet).Changes
references/editorial-rules.md— new "Preview API changes vs. breaking changes" section: use a dedicatedPreview API changessection for preview renames; reserveBreaking changesfor version-to-version breaks of shipped-stable APIs; new default behavior is a feature, not a break; check earlier previews for the original name before writing.references/format-template.md— add aPreview API changessection to the component template and update the section rule.references/api-verification.md— new "Capturing preview API changes" section describing the previous-preview → current-previewdotnet-inspect diffto surface renamed/removed public APIs.references/changes-schema.md— note thatbreaking_changes: truealso covers preview API changes, which the writing stage routes to thePreview API changessection.SKILL.md— mention preview-API-change capture in the pipeline description.Docs-only change to the skill; no code or release-notes content is affected.