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

CDK: add option to source to skip config validation on read/discover #6978

Merged
merged 6 commits into from
Oct 14, 2021

Conversation

htrueman
Copy link
Contributor

What

Closes #6867

How

Add parameter to the Connector class check_config_against_spec.

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/SUMMARY.md
    • 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
  • Connector added to connector index like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command 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
  • Connector version bumped like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub 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.

@CLAassistant
Copy link

CLAassistant commented Oct 12, 2021

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the CDK Connector Development Kit label Oct 12, 2021
@sherifnada
Copy link
Contributor

sherifnada commented Oct 13, 2021

What is the motivation for doing this? Shouldn't the spec be adjusted to what is expected instead? I guess I'm not sure why we add this to the CDK instead of recommending to change the spec

@avida
Copy link
Contributor

avida commented Oct 13, 2021

What is the motivation for doing this? Shouldn't the spec be adjusted to what is expected instead? I guess I'm not sure why we add this to the CDK instead of recommending to change the spec

This ticket was created after based on our discussion for backward compatibility for connectors config #6833 (comment)

@htrueman htrueman requested a review from avida October 13, 2021 10:09
@htrueman htrueman temporarily deployed to more-secrets October 13, 2021 10:10 Inactive
airbyte-cdk/python/CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
@htrueman htrueman temporarily deployed to more-secrets October 14, 2021 14:53 Inactive
@htrueman
Copy link
Contributor Author

htrueman commented Oct 14, 2021

/publish-cdk dry-run=false

🕑 https://github.com/airbytehq/airbyte/actions/runs/1342434047
https://github.com/airbytehq/airbyte/actions/runs/1342434047

@htrueman htrueman temporarily deployed to more-secrets October 14, 2021 15:21 Inactive
@htrueman htrueman merged commit 3adf811 into master Oct 14, 2021
@htrueman htrueman deleted the htrueman/cdk-skip-config-validation-option branch October 14, 2021 15:31
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…irbytehq#6978)

* Add connector check_config_against_spec parameter

* Bump CDK version.
Add changelog record.

* Always enable spec check on check cmd

* Update airbyte-cdk/python/CHANGELOG.md

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
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.

CDK: add option to source to skip config validation on read/discover
5 participants