docs: Fix docgen script to clean out package temp folders first #9250
+14
−6
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
|
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (106,637 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
DellaBitta
approved these changes
Sep 17, 2025
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.
The docgen script starts by running a build on all packages which generates a
packages/[name of package]/temp/directory in each package dir, which contain*.api.jsonfiles. Later on, the script sweeps all these up into a top leveltemp/directory which it uses to generate the docs. The docgen script deletes the top-level directory every time before it runs but not the individual package dirs.That means that leftover api.json files from other branches, etc. might be hanging around since
temp/dirs are gitignored by us, and this causes some confusion when old docs or docs from other packages end up in PRs after runningyarn docgen:all. This fixes it by cleaning out all the package temp dirs before running the build for docgen.