airbytehq/PyAirbyte

We should give guidance to users when they get the error that the CDK version is not new enough

aaronsteers opened this issue · 0 comments

Building a connector in builder uses the latest version of the CDK, and the manifest will include that CDK version in the yaml. Then, when running that connector in PyAirbyte, it will complain that the version is higher than the version of the CDK we are running.

The fix/workaround is for the user to downgrade the version number. In most cases, they can do this without breaking compatibility - except in the case they are using some Builder features or CDK features that were not available in the prior version.

As a longer-term solution, we could:

  • Change this to a warning instead of a hard failure.
  • Modify the error message to explicitly recommend downgrading the version.
  • Use a different versioning scheme in the connector's yaml - for instance, providing a major version number, or listing min version and recommended version as separate fields, etc.