feat: add local docs versioning validation#1427
Merged
Merged
Conversation
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.
Related Issues
Closes #1355
Changes
Why
The existing Docusaurus versioning command snapshots whatever is currently present under
website/docs/. Generated Python API reference pages are produced by the website sync step, so release managers need a deterministic local command that syncs generated API docs before creating a version snapshot and validates the result before any tag-triggered automation is considered.How
versionnpm script with a local wrapper script.npm run version -- <release-version>.website/README.md.This does not add tag-triggered automation, deploy behavior, or CI commits of generated versioned docs.
Checklist
Verification:
node --check website/scripts/version-docs.jsgit diff --check upstream/main..HEADnpm run version(verifies required-version usage error)npm run version -- 1355-local-check(temporary generated version removed after verification)