Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Configuring an API Extractor report for the repo #1081

Merged
merged 2 commits into from
Nov 9, 2020

Conversation

hiranya911
Copy link
Contributor

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.

@bojeil-google
Copy link
Contributor

Hey @hiranya911,
I am assuming any public API changes will still need to be added for review to ./auth/index.ts, for example, along with descriptions which will be used to generate the public API changes.

My understanding of the benefits of API extractor:

  • Detects accidental changes to API.
  • Generates markdown version of the API.

Is there anything else I am missing?

@hiranya911
Copy link
Contributor Author

Yes, that's correct. The markdown report is just intended to make it easier for us to detect and review API changes in a single place.

Other features of API Extractor that we can possibly use in the future:

  1. d.ts rollup: Allows combining multiple d.ts files into one.
  2. API trimming: Allows marking APIs with @alpha, @beta, and @public annotations, and then we can configure which of those APIs should be included in the releases (e.g. we can cut a release that includes beta APIs for an EAP).
  3. API doc generation: Generating markdown or DocFX documentation (this is in the roadmap for Firebase JS as well as other GCP Node.js projects)

@bojeil-google
Copy link
Contributor

Sounds very promising. Thanks for the explanation.

Copy link
Member

@lahirumaramba lahirumaramba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Thanks!

@hiranya911 hiranya911 merged commit 12b02d6 into master Nov 9, 2020
@hiranya911 hiranya911 deleted the hkj-api-report branch November 9, 2020 20:36
BorntraegerMarc pushed a commit to BorntraegerMarc/firebase-admin-node that referenced this pull request Jan 28, 2021
* chore: Configuring an API Extractor report for the repo

* fix: Setting declarationMap via gulpfile so that tests are not affected
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants