Link release note issue references and archive pre-v0.230.001 notes - #1292
Merged
Conversation
Release notes referenced issues as bare `#1289` or `#1145`. Those render as plain text on the docs site, where kramdown does not autolink them, so the references were unusable for readers. - Linkify all 165 references inside `(Ref: ...)` blocks as absolute Markdown links. Each number was classified against the GitHub API first, so the 11 pull request references point at `/pull/` rather than `/issues/`. - Backfill three entries whose shipping PR named an issue the note omitted. Four further candidates were rejected because their PR bundled two unrelated fixes and naming its issue would have credited the wrong bullet. - Move v0.229.063 and older into `archive_release_notes.md`, cutting the current page from 4,781 to 3,797 lines. The move is byte-faithful and verified by reconstructing the original file from the two halves. - Link the archive from the bottom of the release notes and from the docs sidebar under Deep reference. Scoping the rewrite to `(Ref: ...)` blocks is deliberate: the notes also contain prose such as "**Issue #1 - DOM Manipulation Error**", which is a list number rather than a GitHub reference. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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
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.
Why
Release notes referenced issues as bare
#1289ormicrosoft/simplechat#1145. The notes render on the Jekyll docs site, where kramdown does not auto-link either form, so every reference was dead text for readers.While mapping references back to issues, a second problem surfaced: the repository default branch is
main, but every PR merges intoDevelopment. GitHub only honoursFixes #NNNNon merges into the default branch, so no issue has ever auto-closed. 56 shipped issues were still sitting open.What changed
Docs (this PR)
(Ref: ...)blocks as absolute Markdown links. Every number was classified against the GitHub API first, so the 11 pull-request references point at/pull/rather than/issues/.docs/explanation/archive_release_notes.md— 19 sections, 989 lines, down to v0.190.1. The current page drops from 4,781 to 3,797 lines (452 KB → 391 KB).Issues (already applied)
completed, each with a comment naming the shipping PR, the version, and its release-note entries. Repo open issues went 261 → 221.Attribution method
Line-level attribution uses each merged PR's own patch of
release_notes.md, not the commit → PR API. That API returns every PR whose branch merely contains a commit; open long-lived branch #1228 contains 132 unrelated commits and was initially credited with work spanning 30+ versions it never touched.Deliberate restraint
(Ref: ...)blocks. The notes also contain prose like**Issue #1 - DOM Manipulation Error**— a list number, not a reference. Blanket linkification would have corrupted it.Not closed, needs a human call
Closes #1143, related #1047 and #358Verification
A validator reconstructs the original file from the two halves, normalizes the links back to their pre-edit spelling, and requires an exact match against
HEAD:Docs-only, so no
config.pyversion bump per repo rules.Follow-up worth filing
The
Developmentvsmainmismatch will keep stranding issues. Either change the default branch, or add a workflow that closes referenced issues on merge intoDevelopment.