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

Airbyte Protocol v1 #19846

Merged
merged 6 commits into from
Nov 30, 2022
Merged

Airbyte Protocol v1 #19846

merged 6 commits into from
Nov 30, 2022

Conversation

gosusnp
Copy link
Contributor

@gosusnp gosusnp commented Nov 28, 2022

What

Introduce v1 of the Airbyte Protocol.
v1 is going to be starting from the introduction of the well-known data types (#17486).

In order to allow from v0 and v1 to coexists for the transition period, create explicit instances of v0, v1 so that platform/connectors can pick which set of generated objects to use.

How

  • Make sure we have versioned yaml files for the protocol:
    • airbyte-protocol/.../airbyte_protocol/v0/airbyte_protocol.yaml: previous version
    • airbyte-protocol/.../airbyte_protocol/v1/airbyte_protocol.yaml: current version, simlink to ../airbyte_protocol.yaml
    • airbyte-protocol/.../airbyte_protocol/airbyte_protocol.yaml: v1 with data types changes
  • Update changelog

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

No breaking changes other than making v1 available explicitly

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
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:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@gosusnp gosusnp requested a review from a team as a code owner November 28, 2022 21:10
@octavia-squidington-iv octavia-squidington-iv added area/documentation Improvements or additions to documentation area/platform issues related to the platform area/protocol labels Nov 28, 2022
@gosusnp gosusnp temporarily deployed to more-secrets November 28, 2022 21:13 Inactive
@gosusnp gosusnp temporarily deployed to more-secrets November 28, 2022 21:13 Inactive
@gosusnp gosusnp requested a review from edgao November 28, 2022 22:20
Copy link
Contributor

@edgao edgao left a comment

Choose a reason for hiding this comment

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

just to confirm my understanding: this means that v1 is referencing the live version https://github.com/airbytehq/airbyte/blob/master/airbyte-protocol/protocol-models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml, and v0 has the hardcoded copy?

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.

Exciting!

My approval is dependent on the tests passing

@gosusnp gosusnp temporarily deployed to more-secrets November 29, 2022 15:51 Inactive
@gosusnp gosusnp temporarily deployed to more-secrets November 29, 2022 15:51 Inactive
@gosusnp gosusnp temporarily deployed to more-secrets November 29, 2022 19:50 Inactive
@gosusnp gosusnp temporarily deployed to more-secrets November 29, 2022 19:50 Inactive
@gosusnp gosusnp temporarily deployed to more-secrets November 29, 2022 20:52 Inactive
@gosusnp gosusnp temporarily deployed to more-secrets November 29, 2022 20:53 Inactive
@gosusnp gosusnp merged commit 5a2642a into master Nov 30, 2022
@gosusnp gosusnp deleted the gosusnp/protocol-versioning-v1 branch November 30, 2022 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/platform issues related to the platform area/protocol
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants