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

feat: Add script to check public API visibility #95

Merged
merged 12 commits into from
Sep 2, 2024
Merged

Conversation

shibeshduw
Copy link
Contributor

@shibeshduw shibeshduw commented Aug 30, 2024

Context

Closes: AI/gen-ai-hub-sdk-js-backlog#94

This PR adds a script to check for all public APIs (similar to cloud-sdk-js with small adjustments) to ensure that the external API is exported completely and visible to the user. It also checks that everything not exported to the public API is marked with @internal.

Definition of Done

  • Code is tested (Unit, E2E)
  • Error handling created / updated & covered by the tests above
  • Documentation updated
  • (Optional) Aligned changes with the Java SDK
  • (Optional) Release notes updated

Copy link
Member

@tomfrenken tomfrenken left a comment

Choose a reason for hiding this comment

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

Overall LGTM, however some minor changes are still necessary.

Also, please add the check to our pipeline, e.g. same as we do in the cloud sdk.

Copy link
Member

@tomfrenken tomfrenken left a comment

Choose a reason for hiding this comment

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

LGTM

@tomfrenken tomfrenken merged commit 0f94413 into main Sep 2, 2024
9 checks passed
@tomfrenken tomfrenken deleted the public-api-check branch September 2, 2024 12:03
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