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

bulk-cdk: complete README #43391

Merged
merged 3 commits into from
Aug 8, 2024
Merged

Conversation

postamar
Copy link
Contributor

@postamar postamar commented Aug 8, 2024

What

Complete README for the Bulk CDK.

Fixes https://github.com/airbytehq/airbyte-internal-issues/issues/9049

User Impact

None

Can this PR be safely reverted and rolled back?

  • YES πŸ’š
  • NO ❌

Copy link

vercel bot commented Aug 8, 2024

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Aug 8, 2024 3:59pm

@postamar postamar requested a review from evantahler August 8, 2024 15:38
@octavia-squidington-iii octavia-squidington-iii added the CDK Connector Development Kit label Aug 8, 2024
Copy link
Contributor

@evantahler evantahler left a comment

Choose a reason for hiding this comment

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

πŸ’ͺ
All my comments are nits. I will start a thread to confirm the license choice, but that's an easy change later if we change our mind at this early stage, and shouldn't block this PR


## Structure

The Bulk CDK consists of a _core_ and a bunch of _toolkits_.
Copy link
Contributor

Choose a reason for hiding this comment

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

πŸ‘ These terms have really grown on me!


While BOMs are undoubtedly useful, let's still try to keep external dependencies to a minimum
outside of tests.
Less dependencies, less problems.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there some guidance that we want the lower parts of the CDK to have as few dependencies as possible, but the toolkits can gain deps?

Copy link
Contributor Author

@postamar postamar Aug 8, 2024

Choose a reason for hiding this comment

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

I don't know about that. Toolkits should also stay slim, in my opinion. Where it matters a lot less is tests, but even so, with gradle when you have a lot of dependencies (and therefore, conflicts) it's super easy to declare depending on version X but really because of a transitive dependency you're using version Y instead, without knowing. Typically what then happens is when you bump the declared dep to a later version Z a whole bunch of unrelated stuff breaks.

Comment on lines +104 to +107
## Licensing

The license for the Bulk CDK is Elastic License 2.0, as specified by the LICENSE file in the root
of this git repository.
Copy link
Contributor

Choose a reason for hiding this comment

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

cc @Hesperide:
I think this is the right license because:

  1. We do want to allow community members to create fee/OSS connectors using the CDK
  2. We con't want AWS stealing our code and competing with us

This is a departure from our current CDK license, which is MIT

Copy link
Contributor

Choose a reason for hiding this comment

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

Marius Posta and others added 2 commits August 8, 2024 08:58
@postamar postamar merged commit 6006a4f into master Aug 8, 2024
30 checks passed
@postamar postamar deleted the postamar/add-bulk-cdk-documentation branch August 8, 2024 20:54
LouisAuneau pushed a commit to LouisAuneau/airbyte that referenced this pull request Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CDK Connector Development Kit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants