Simplify check for reference doc changes #7014
Merged
Conversation
This file contains 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 1Affected Products
Test Logs |
833a105 to
d47ad01
Compare
lisajian
reviewed
Feb 13, 2023
| @@ -96,6 +96,7 @@ packages/app-check-interop-types @hsubox76 @firebase/jssdk-global-approvers | |||
| # Documentation Changes | |||
| packages/firebase/index.d.ts @egilmorez @firebase/jssdk-global-approvers | |||
| scripts/docgen/content-sources/ @egilmorez @firebase/jssdk-global-approvers | |||
| docs-devsite/ @egilmorez @markarndt | |||
There was a problem hiding this comment.
I don't think Mark has write access to this repo? cc: @markarndt
There was a problem hiding this comment.
I've added him, let me know if any other tech writers ought to be added.
common/api-review/auth.api.md
Outdated
| @@ -647,6 +653,9 @@ export interface ReactNativeAsyncStorage { | |||
| setItem(key: string, value: string): Promise<void>; | |||
| } | |||
|
|
|||
| // @public | |||
| export const reactNativeLocalPersistence: Persistence; | |||
There was a problem hiding this comment.
Does getReactNativePersistence also need to be exported here? I think it's exported out of index.doc.d.ts alongside reactNativeLocalPersistence
There was a problem hiding this comment.
Just removed this file from the PR.
packages/auth/api-extractor.json
Outdated
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "extends": "../../config/api-extractor.json", | |||
| "mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.d.ts", | |||
| "mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.doc.d.ts", | |||
There was a problem hiding this comment.
I don't have enough context around why we had index.d.ts as the main entry point instead of index.doc.d.ts - maybe @sam-gc to weigh in?
There was a problem hiding this comment.
Sorry, this is an artifact of the doc generation process and shouldn't be checked in. Removing it.
d47ad01 to
01654a7
Compare
lisajian
approved these changes
Feb 13, 2023
markarndt
approved these changes
Feb 14, 2023
5298827 to
64fae79
Compare
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.
The plan is:
docs-devsite/in the repo. (This will be done in a future PR because it is 189 files and will make this PR difficult to review.)check-docs.yml. This will run new doc generation and do agit-diff. If there are any changes it will fail and print a message asking the user to runyarn docgen devsitelocally.docs-devsite/directory.