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

🎉 New Destination: Yellowbrick #35775

Merged
merged 18 commits into from
Apr 30, 2024
Merged

🎉 New Destination: Yellowbrick #35775

merged 18 commits into from
Apr 30, 2024

Conversation

markcusack
Copy link
Contributor

What

Adds a new destination connector for the Yellowbrick database following demand from Yellowbrick customers.

How

Implements a V2 destination connector for Yellowbrick.

Recommended reading order

  1. YellowbrickDestination.java

🚨 User Impact 🚨

New destination connector. No user impact.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Screenshot 2024-03-02 at 5 58 20 PM
  • Community member? Grant edit access to maintainers (instructions)
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:generateScaffolds then checking in your changes
  • Documentation which references the generator is updated as needed
Updating the Python CDK

Airbyter

Before merging:

  • Pull Request description explains what problem it is solving
  • Code change is unit tested
  • Build and my-py check pass
  • Smoke test the change on at least one affected connector
    • On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
    • Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
  • PR is reviewed and approved

After merging:

  • Publish the CDK
    • The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
    • Write a thoughtful changelog message so we know what was updated.
  • Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
    • This step is optional if the change does not affect the connector builder or declarative connectors.

Copy link

vercel bot commented Mar 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Apr 29, 2024 5:22pm

@CLAassistant
Copy link

CLAassistant commented Mar 2, 2024

CLA assistant check
All committers have signed the CLA.

@marcosmarxm
Copy link
Member

Thanks for the contribution @markcusack I'm going to create a sandbox to run integration tests to your code.

@markcusack
Copy link
Contributor Author

Thanks for the contribution @markcusack I'm going to create a sandbox to run integration tests to your code.

Thanks! Is this a Yellowbrick sandbox? I.e. a connection to our free cloud-based Yellowbrick instance, or a different sandbox?

@marcosmarxm
Copy link
Member

Free cloud-based sandbox

@markcusack
Copy link
Contributor Author

Free cloud-based sandbox

The Yellowbrick sandbox is fairly locked down, and regular sandbox users don't have permission to create a new database, which the integration tests require -- a database is created just for them. We can relax the permissions to allow database creation while you're running the tests, however. Let me know the email address you've signed up for and I'll ask the team to give you more extensive permissions.

@marcosmarxm
Copy link
Member

Sent email in Slack DM.

@marcosmarxm marcosmarxm merged commit 39f036a into airbytehq:master Apr 30, 2024
61 of 62 checks passed
@marcosmarxm
Copy link
Member

Hello @markcusack your feedback matters a lot to us. Can you spare just 3 minutes to complete a survey? We're dedicated to making the contributor experience even better, and your input is key to achieving excellence. Thank you for helping us improve!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation community connectors/destination/yellowbrick
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants