<@U04SE163WC8> how to skip qa checks with airbyte-...
# ask-ai
m
@kapa.ai how to skip qa checks with airbyte-ci?
u
The
airbyte-ci
tool does not directly provide an option to skip QA checks. However, it does provide a
--skip-step
option that can be used to skip specific steps in the test suite. The exact step name for the QA checks would need to be known to use this option. Here is an example of how to use the
--skip-step
option:
Copy code
bash airbyte-ci connectors --name=<connector_name> --skip-step=<step_name> test
Please replace
<connector_name>
with the name of your connector and
<step_name>
with the name of the step you want to skip. However, it's important to note that QA checks are crucial for ensuring that a connector is following the best practices and is respecting the Airbyte standards. These checks are used to ensure a connector can be safely integrated into the Airbyte platform and released to registries. Therefore, skipping these checks should be done with caution. For more information on how to use
airbyte-ci
, you can refer to the [official documentation](https://docs.airbyte.com/connector-development/testing-connectors/#-ci).
m
@kapa.ai what is the step_name for qa checks?
u
A message from kapa.ai
u
I'm sorry, but the knowledge sources provided do not specify the exact
step_name
for the QA checks in the
airbyte-ci
tool. It's recommended to refer to the official Airbyte documentation or the
airbyte-ci
tool's help output for the exact step names.
m
@kapa.ai I’ve created a custom data source, where do I add the changelog entry to pass the qa test?
u
A message from kapa.ai
u
For each new version of a connector, a changelog entry must be defined in the user-facing documentation. The changelog should be added to the connector's documentation file, which is located at
./docs/integrations/<connector-type>s/<connector-name>.md
. Here is the structure you should follow:
Copy code
# Changelog | Version | Date       | Pull Request | Subject | | :------ | :--------: | :-----:      | :-----: | | 0.1.0   | 2021-07-23 | [#3290](<https://github.com/airbytehq/airbyte/pull/3290>) [#4939](<https://github.com/airbytehq/airbyte/pull/4939>) | Initial release. |
Please replace
<connector-type>
with the type of your connector (source or destination) and
<connector-name>
with the name of your connector. For more details, please refer to the [official documentation](https://docs.airbyte.com/contributing-to-airbyte/resources/qa-checks#connectors-must-have-a-changelog-entry-for-each-version).
m
@kapa.ai how to fix this error:
Copy code
Connectors must have an icon: Icon file is missing. Please create an icon file at the root of the connector code directory..
u
A message from kapa.ai
u
To fix the error "Connectors must have an icon: Icon file is missing. Please create an icon file at the root of the connector code directory.", you need to add an SVG file named
icon.svg
at the root of your connector's code directory. This file should be a square and serve as the icon for your connector. Here are the steps to fix this: 1. Create an SVG file that will serve as the icon for your connector. The icon should be a square. 2. Name this file
icon.svg
. 3. Place this file at the root of your connector's code directory. This requirement applies to all connector types (source, destination) and languages (java, low-code, python, manifest-only), and at any support level or Airbyte usage level. For more information, please refer to the [official documentation](https://docs.airbyte.com/contributing-to-airbyte/resources/qa-checks#-assets).
m
@kapa.ai what to add to
releaseDate
for metadata.yaml
u
A message from kapa.ai
u
The
releaseDate
field is not mentioned in the provided knowledge sources. Therefore, I can't provide a confident answer about what to add to the
releaseDate
for the
metadata.yaml
file. For accurate information, please refer to the official Airbyte documentation or the specific guidelines provided for the
metadata.yaml
file.
m
@kapa.ai how to fix this error:
Copy code
appsflyer-low-code - ❌ Failed - Connectors must have valid metadata.yaml file: Metadata file is invalid: Validation error: 1 validation error for ConnectorMetadataDefinitionV0
data -> registries
  extra fields not permitted (type=value_error.extra).
Error: 1 checks failed
u
A message from kapa.ai
u
The error message indicates that there are extra fields in the
registries
section of your
metadata.yaml
file that are not permitted. The
registries
section should look something like this:
Copy code
yaml registries:     cloud:       dockerRepository: airbyte/source-postgres-strict-encrypt       enabled: true     oss:       enabled: true
In this example, both
cloud
and
oss
registries are enabled, and the Docker repository for the
cloud
registry is overrode to
airbyte/source-postgres-strict-encrypt
. You should remove any extra fields that are not
dockerRepository
or
enabled
under the
cloud
and
oss
sections. For more information, please refer to the [official documentation](https://docs.airbyte.com/connector-development/connector-metadata-file#the-registries-section).