Skip to content

docs(NODE-5423): export all public FLE types and classes #3794

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

Merged
merged 3 commits into from
Aug 8, 2023

Conversation

baileympearson
Copy link
Contributor

@baileympearson baileympearson commented Aug 3, 2023

Description

What is changing?

Is there new documentation needed for these changes?

All relevant FLE types have been exported. The full list can be found in NODE-5432.

Some types are poorly named (i.e., ClientEncryptionKMSProviders is not only used for ClientEncryption) but I left the the names to reduce breakages for users. In a future major, we can rename these types if we'd like.

What is the motivation for this change?

Release Highlight

Double check the following

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@baileympearson baileympearson force-pushed the NODE-5423-exports-and-api-docs branch from d522411 to a45ebdb Compare August 3, 2023 21:25
@baileympearson baileympearson changed the title Node 5423 exports and api docs docs(NODE-5432): export all public FLE types and classes Aug 4, 2023
@baileympearson baileympearson marked this pull request as ready for review August 4, 2023 14:33
@durran durran self-assigned this Aug 7, 2023
@durran durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Aug 7, 2023
Copy link
Member

@durran durran left a comment

Choose a reason for hiding this comment

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

Just a few questions.

@baileympearson baileympearson changed the title docs(NODE-5432): export all public FLE types and classes docs(NODE-5423): export all public FLE types and classes Aug 7, 2023
@baileympearson baileympearson requested a review from durran August 7, 2023 17:53
@baileympearson
Copy link
Contributor Author

Looks like potential merge of the PR on libmongocrypt may have caused a CI failure here? evergreen.mongodb.com/lobster/evergreen/task/mongo_node_driver_next_rhel8_custom_dependency_tests_run_custom_csfle_tests_5.0_master_patch_fee8d3e094846222035962c75a207e14b70325c7_64d1295b32f4171eb5d4095a_23_08_07_17_26_52/0/task#bookmarks=0%2C1396&l=1&shareLine=1341

Neal's fixed it here: https://github.com/mongodb/node-mongodb-native/pull/3797/files

That was debugging code that I added to CI and forgot to remove

@durran durran added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Aug 7, 2023
@durran durran merged commit 05cf04b into main Aug 8, 2023
@durran durran deleted the NODE-5423-exports-and-api-docs branch August 8, 2023 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants