Exclude unwanted packages in docgen script #6469
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
|
hsubox76
changed the title
Size Report 1Affected ProductsNo changes between base commit (57b00d4) and merge commit (0601a80).Test Logs |
Size Analysis Report 1Affected ProductsNo changes between base commit (57b00d4) and merge commit (0601a80).Test Logs |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add a
toccommand to the docgen script for finer control of callingapi-documenter toc, so we can temporarily removeapi.jsonfiles for packages we don't want to get into the TOC, including app-compat, util, and rules-unit-testing.Also added code to remove the actual markdown documentation files of those excluded packages as a post-process step when running regular
api-documenter devsite. Packages are interdependent on each other in some ways when api-extractor is running, so excluding them before that step might cause unexpected results.Also the toc.yaml got accidentally checked in at some point. Removed it and added it to .gitignore.
When this is merged we should update https://source.corp.google.com/piper///depot/google3/firebase/jscore/tools/regenerate-reference-latest;l=26 to simply use
yarn docgen tocinstead of calling api-documenter-devsite directly, and we don't need the manual cleanup steps anymore.