Skip to content

fix(docs): run JSDoc once per documentation build - #3958

Open
ShiroKSH wants to merge 2 commits into
googleapis:mainfrom
ShiroKSH:fix/docs-run-jsdoc-once
Open

fix(docs): run JSDoc once per documentation build#3958
ShiroKSH wants to merge 2 commits into
googleapis:mainfrom
ShiroKSH:fix/docs-run-jsdoc-once

Conversation

@ShiroKSH

@ShiroKSH ShiroKSH commented Aug 1, 2026

Copy link
Copy Markdown

Description

Fixes #3957.

The JSDoc migration stopped passing the API directory to the documentation command but preserved the old per-directory loop. Since .jsdoc.js recursively reads all of build/src, every iteration regenerated the same documentation tree.

Impact

Documentation output is generated once from the same built source tree. This avoids 331 redundant JSDoc processes and concurrent writes to the shared docs/ directory.

Testing

  • Compiled src/generator/docs.ts and test/test.docs.ts, then ran npx mocha build/test/test.docs.js.
  • Ran npx eslint src/generator/docs.ts test/test.docs.ts.

Additional Information

No generated API clients or public API surface changed.

Checklist

@ShiroKSH
ShiroKSH requested a review from a team as a code owner August 1, 2026 17:23
@product-auto-label product-auto-label Bot added the size: s Pull request size is small. label Aug 1, 2026
@google-cla

google-cla Bot commented Aug 1, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@westarle

westarle commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

@ShiroKSH I need you to sign the CLA here to consider the change.

@ShiroKSH

ShiroKSH commented Aug 4, 2026

Copy link
Copy Markdown
Author

@ShiroKSH I need you to sign the CLA here to consider the change.

image

@westarle westarle added kokoro:run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Aug 4, 2026
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Aug 4, 2026
@yoshi-kokoro yoshi-kokoro removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Aug 4, 2026
@westarle westarle added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. labels Aug 4, 2026
@yoshi-kokoro yoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Aug 4, 2026
@westarle westarle added the owlbot:run Add this label to trigger the Owlbot post processor. label Aug 4, 2026
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Aug 4, 2026
@westarle westarle added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 4, 2026
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: s Pull request size is small.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs generator runs JSDoc once per API directory

3 participants