Skip to content

Commit 4a0ad0a

Browse files
Update qa-checks.md generation path to reflect Docusaurus multi-instance structure (#69181)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: [email protected] <[email protected]>
1 parent eacc50a commit 4a0ad0a

File tree

23 files changed

+45
-463
lines changed

23 files changed

+45
-463
lines changed

airbyte-ci/connectors/connectors_qa/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ commit it in your PR.**:
8585

8686
```bash
8787
# From airbyte repo root
88-
connectors-qa generate-documentation docs/contributing-to-airbyte/resources/qa-checks.md
88+
connectors-qa generate-documentation docs/community/contributing-to-airbyte/resources/qa-checks.md
8989
```
9090

9191
### Running tests

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/documentation/templates/documentation_headers_check_description.md.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The user facing connector documentation should follow the guidelines defined in the [standard template](../../../airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/documentation/templates/template.md.j2).
1+
The user facing connector documentation should follow the guidelines defined in the [standard template](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/documentation/templates/template.md.j2).
22

33
This check expects the following order of headers in the documentation:
44

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
The user facing connector documentation should follow the guidelines defined in the [standard template](../../../airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/documentation/templates/template.md.j2).
1+
The user facing connector documentation should follow the guidelines defined in the [standard template](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/documentation/templates/template.md.j2).
22

33
Check verifies that {{ header }} header section content follows standard template:
44

55
````
66
{{ template }}
7-
````
7+
````

airbyte-ci/connectors/connectors_qa/src/connectors_qa/templates/qa_checks.md.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!--
44
THIS FILE IS GENERATED BY THE CONNECTORS-QA CLI. DO NOT EDIT THIS FILE MANUALLY.
55
IF YOU NEED TO EDIT IT, EDIT THE TEMPLATE: https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/connectors_qa/src/connectors_qa/templates/qa_checks.md.j2
6-
AND REGENERATE THE DOCS BY RUNNING `poetry run connectors-qa generate-documentation docs/connectors-qa.md`
6+
AND REGENERATE THE DOCS BY RUNNING `connectors-qa generate-documentation docs/community/contributing-to-airbyte/resources/qa-checks.md` FROM THE AIRBYTE REPO ROOT
77
-->
88

99
This document is listing all the static-analysis checks that are performed on the Airbyte connectors.

airbyte-ci/connectors/connectors_qa/tests/integration_tests/test_documentation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
from connectors_qa.cli import generate_documentation
1111

12-
DOCUMENTATION_FILE_PATH_IN_AIRBYTE_REPO = Path("docs/contributing-to-airbyte/resources/qa-checks.md")
12+
DOCUMENTATION_FILE_PATH_IN_AIRBYTE_REPO = Path("docs/community/contributing-to-airbyte/resources/qa-checks.md")
1313

1414

1515
@pytest.fixture

docs/community/contributing-to-airbyte/resources/qa-checks.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!--
44
THIS FILE IS GENERATED BY THE CONNECTORS-QA CLI. DO NOT EDIT THIS FILE MANUALLY.
55
IF YOU NEED TO EDIT IT, EDIT THE TEMPLATE: https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/connectors_qa/src/connectors_qa/templates/qa_checks.md.j2
6-
AND REGENERATE THE DOCS BY RUNNING `poetry run connectors-qa generate-documentation docs/connectors-qa.md`
6+
AND REGENERATE THE DOCS BY RUNNING `connectors-qa generate-documentation docs/community/contributing-to-airbyte/resources/qa-checks.md` FROM THE AIRBYTE REPO ROOT
77
-->
88

99
This document is listing all the static-analysis checks that are performed on the Airbyte connectors.
@@ -334,7 +334,7 @@ _Applies to connector with any support level_
334334
_Applies to connector with any internal support level_
335335
_Applies to connector with any Airbyte usage level_
336336

337-
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](https://docs.airbyte.com/community/licenses/license-faq).
337+
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](https://docs.airbyte.com/developer-guides/licenses/license-faq).
338338

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

@@ -421,14 +421,14 @@ _Applies to connector with any Airbyte usage level_
421421
Connectors must use our Python connector base image (`docker.io/airbyte/python-connector-base`), declared through the `connectorBuildOptions.baseImage` in their `metadata.yaml`.
422422
This is to ensure that all connectors use a base image which is maintained and has security updates.
423423

424-
## 🧪 Testing
424+
## 🔢 Version
425425

426-
### Medium to High Use Connectors must enable acceptance tests
426+
### Connector Version Increment Check
427427

428-
_Applies to the following connector types: source_
428+
_Applies to the following connector types: source, destination_
429429
_Applies to the following connector languages: java, low-code, python, manifest-only_
430430
_Applies to connector with any support level_
431431
_Applies to connector with any internal support level_
432-
_Applies to connector with medium, high Airbyte usage level_
432+
_Applies to connector with any Airbyte usage level_
433433

434-
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.
434+
Validates that the connector version was incremented if files were modified.

0 commit comments

Comments
 (0)