Repository navigation
Prefer documentation tags when publishing JSDoc - #1625
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Tag-triggered deployments use tooling from the source tag, and the promised regression tests are absent.
2 open findings
What changed in this PR
Updates JSDoc publishing to prefer version-specific documentation tags while retaining release-tag fallback and validation.
Changes:
- Resolves and validates documentation source tags.
- Logs selected sources and documents the policy.
- Updates manifest guidance.
| File | Description |
|---|---|
tools/jsdoc/regenerate-published-docs.js |
Adds source-tag selection and version validation. |
tools/jsdoc/README.md |
Documents publishing and tag behavior. |
tools/jsdoc/published-versions.json |
Updates manifest guidance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+57
to
+58
| The workflow's branch selector chooses the deployment tooling, not the source | ||
| for each documentation version. The generator applies this rule independently |
| main(); | ||
| } | ||
|
|
||
| module.exports = { resolveDocumentationSources }; |
|
coverage: 91.156% (-0.001%) from 91.157% — minggangw:fix-1623-1 into RobotWebTools:develop |
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.
Fix: #1623