Airbyte connectors QA checks

This document is listing all the static-analysis checks that are performed on the Airbyte connectors. These checks are running in our CI/CD pipeline and are used to ensure a connector is following the best practices and is respecting the Airbyte standards. Meeting these standards means that the connector will be able to be safely integrated into the Airbyte platform and released to registries (DockerHub, Pypi etc.). You can consider these checks as a set of guidelines to follow when developing a connector. They are by no mean replacing the need for a manual review of the connector codebase and the implementation of good test suites.

📄 Documentation

Breaking changes must be accompanied by a migration guide

Applies to the following connector types: source, destination Applies to the following connector languages: java, low-code, python, manifest-only Applies to connector with any support level Applies to connector with any Airbyte usage level

When a breaking change is introduced, we check that a migration guide is available. It should be stored under ./docs/integrations/<connector-type>s/<connector-name>-migrations.md. This document should contain a section for each breaking change, in order of the version descending. It must explain users which action to take to migrate to the new version.

Connectors must have user facing documentation

The user facing connector documentation should be stored under ./docs/integrations/<connector-type>s/<connector-name>.md.

Connectors must have a changelog entry for each version

Each new version of a connector must have a changelog entry defined in the user facing documentation in ./docs/integrations/<connector-type>s/<connector-name>.md.

📝 Metadata

Connectors must have valid metadata.yaml file

Connectors must have a metadata.yaml file at the root of their directory. This file is used to build our connector registry. Its structure must follow our metadata schema. Field values are also validated. This is to ensure that all connectors have the required metadata fields and that the metadata is valid. More details in this documentation.

Connector must have a language tag in metadata

Connectors must have a language tag in their metadata. It must be set in the tags field in metadata.yaml. The values can be language:python or language:java. This checks infers the correct language tag based on the presence of certain files in the connector directory.

Python connectors must have a CDK tag in metadata

Applies to the following connector types: source, destination Applies to the following connector languages: python, low-code Applies to connector with any support level Applies to connector with any Airbyte usage level

Python connectors must have a CDK tag in their metadata. It must be set in the tags field in metadata.yaml. The values can be cdk:low-code, cdk:python, or cdk:file.

Breaking change deadline should be a week in the future

If the connector version has a breaking change, the deadline field must be set to at least a week in the future.

Certified source connector must have a value filled out for maxSecondsBetweenMessages in metadata

Applies to the following connector types: source Applies to the following connector languages: java, low-code, python, manifest-only Applies to connector with certified support level Applies to connector with any Airbyte usage level

Certified source connectors must have a value filled out for maxSecondsBetweenMessages in metadata. This value represents the maximum number of seconds we could expect between messages for API connectors. And it's used by platform to tune connectors heartbeat timeout. The value must be set in the 'data' field in connector's metadata.yaml file.

📦 Packaging

Connectors must use Poetry for dependency management

Connectors must use Poetry for dependency management. This is to ensure that all connectors use a dependency management tool which locks dependencies and ensures reproducible installs.

Connectors must be licensed under MIT or Elv2

Connectors must be licensed under the MIT or Elv2 license. This is to ensure that all connectors are licensed under a permissive license. More details in our License FAQ.

Connector license in metadata.yaml and pyproject.toml file must match

Connectors license in metadata.yaml and pyproject.toml file must match. This is to ensure that all connectors are consistently licensed.

Connector version must follow Semantic Versioning

Connector version must follow the Semantic Versioning scheme. This is to ensure that all connectors follow a consistent versioning scheme. Refer to our Semantic Versioning for Connectors for more details.

Connector version in metadata.yaml and pyproject.toml file must match

Connector version in metadata.yaml and pyproject.toml file must match. This is to ensure that connector release is consistent.

Python connectors must have PyPi publishing enabled

Applies to the following connector types: source Applies to the following connector languages: python, low-code Applies to connector with any support level Applies to connector with any Airbyte usage level

Python connectors must have PyPi publishing enabled in their metadata.yaml file. This is declared by setting remoteRegistries.pypi.enabled to true in metadata.yaml. This is to ensure that all connectors can be published to PyPi and can be used in PyAirbyte.

Manifest-only connectors must use `source-declarative-manifest` as their base image

Applies to the following connector types: source, destination Applies to the following connector languages: manifest-only Applies to connector with any support level Applies to connector with any Airbyte usage level

Manifest-only connectors must use airbyte/source-declarative-manifest as their base image.

💼 Assets

Connectors must have an icon

Each connector must have an icon available in at the root of the connector code directory. It must be an SVG file named icon.svg and must be a square.

🔒 Security

Connectors must use HTTPS only

Connectors must use HTTPS only when making requests to external services.

Python connectors must not use a Dockerfile and must declare their base image in metadata.yaml file

Applies to the following connector types: source, destination Applies to the following connector languages: python, low-code, manifest-only Applies to connector with any support level Applies to connector with any Airbyte usage level

Connectors must use our Python connector base image (docker.io/airbyte/python-connector-base), declared through the connectorBuildOptions.baseImage in their metadata.yaml. This is to ensure that all connectors use a base image which is maintained and has security updates.

🧪 Testing

Medium to High Use Connectors must enable acceptance tests

Applies to the following connector types: source Applies to the following connector languages: java, low-code, python, manifest-only Applies to connector with any support level Applies to connector with medium, high Airbyte usage level

Medium to High Use Connectors must enable acceptance tests via the connectorTestSuitesOptions.suite:acceptanceTests in their respective metadata.yaml file to ensure that the connector is working as expected.

Airbyte connectors QA checks

📄 Documentation​

Breaking changes must be accompanied by a migration guide​

Connectors must have user facing documentation​

Connectors must have a changelog entry for each version​

📝 Metadata​

Connectors must have valid metadata.yaml file​

Connector must have a language tag in metadata​

Python connectors must have a CDK tag in metadata​

Breaking change deadline should be a week in the future​

Certified source connector must have a value filled out for maxSecondsBetweenMessages in metadata​

📦 Packaging​

Connectors must use Poetry for dependency management​

Connectors must be licensed under MIT or Elv2​

Connector license in metadata.yaml and pyproject.toml file must match​

Connector version must follow Semantic Versioning​

Connector version in metadata.yaml and pyproject.toml file must match​

Python connectors must have PyPi publishing enabled​

Manifest-only connectors must use source-declarative-manifest as their base image​

💼 Assets​

Connectors must have an icon​

🔒 Security​

Connectors must use HTTPS only​

Python connectors must not use a Dockerfile and must declare their base image in metadata.yaml file​

🧪 Testing​

Medium to High Use Connectors must enable acceptance tests​