docs(release-docs): reconcile next docs changes into newly cut version#24235
Open
critesjosh wants to merge 2 commits into
Open
docs(release-docs): reconcile next docs changes into newly cut version#24235critesjosh wants to merge 2 commits into
critesjosh wants to merge 2 commits into
Conversation
The new docs version is cut from the release tag, which predates docs changes merged into next. Rewrite Step 14 to diff the tag against origin/next and backport relevant changes — covering both the source docs and fixes applied directly to the previous versioned snapshot, the latter of which the prior wording never inspected.
…config Steps 5 and 13 overwrite the local version configs with the new version before Step 14 runs, so reading <prev_version> from the working-tree config would yield the new version and point the snapshot diff at the wrong directory. Read it from origin/next instead.
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.
What
Rewrites Step 14 of the
release-docsskill (.claude/skills/release-docs/SKILL.md) to reliably catch documentation changes that landed onnextbut won't be present in a version cut from the release tag.Why
A new docs version (e.g.
5.1.0) is cut from the release tag, which is older thannext. Any docs work merged intonextafter the tag is therefore missing from the freshly cut snapshot. The previous Step 14 gestured at this but had two gaps:next(e.g.developer_versioned_docs/version-v5.0.0-rc.1/...) was never reviewed.next.Changes
nextDocs Changes Into the New Version") to explain the tag-vs-nextdivergence up front.origin/next(not the working tree):git log v<new>..origin/next -- docs/, plus per-area diffs for source docs and the previous snapshot directory.