chore: Configuring an API Extractor report for the repo #1081
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.
This PR configures an API Extractor report for the project. This allows us to track changes made to our public API surface, and avoid accidental API changes.
etc/firebase-admin.api.md
. See the rendered markdown version at https://github.com/firebase/firebase-admin-node/blob/hkj-api-report/etc/firebase-admin.api.mdnpm run api-extractor:local
to update the API report file locally, and push the changes as part of their PR. This provides us a signal whenever the public API is being intentionally updated. Also the markdown format makes it easier to review public API changes.firebase-namespace.d.ts
file as the entry point for our API report. We cannot useindex.d.ts
until API Extractor supports some additional TS features: