feat(qa_check): enable checking connector docs structure via qa check

airbyte-ci/connectors/connector_ops/connector_ops/utils.py

@@ -3,6 +3,7 @@
 #
 
 import functools
+import json
 import logging
 import os
 import re
@@ -383,6 +384,25 @@ def metadata(self) -> Optional[dict]:
             return None
         return yaml.safe_load((self.code_directory / METADATA_FILE_NAME).read_text())["data"]
 
+    @property
+    def connector_spec_file_content(self) -> Optional[dict]:
+        """
+        Returns spec file content from spec.yaml, spec.json, manifest.yaml.
+        This spec is not a "source of truth" for connector specification and can't be used as is.
+        """
+        yaml_spec = Path(self.python_source_dir_path / "spec.yaml")
+        json_spec = Path(self.python_source_dir_path / "spec.json")
+
+        if yaml_spec.exists():
+            return yaml.safe_load(yaml_spec.read_text())
+        elif json_spec.exists():
+            with open(json_spec) as f:
+                return json.load(f)
+        elif self.manifest_path.exists():
+            return yaml.safe_load(self.manifest_path.read_text())["spec"]
+
+        return None
+
     @property
     def language(self) -> ConnectorLanguage:
         if Path(self.code_directory / self.technical_name.replace("-", "_") / "manifest.yaml").is_file():

airbyte-ci/connectors/connector_ops/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "connector_ops"
-version = "0.5.0"
+version = "0.5.1"
 description = "Packaged maintained by the connector operations team to perform CI for connectors"
 authors = ["Airbyte <contact@airbyte.io>"]
 

airbyte-ci/connectors/connectors_qa/README.md

@@ -108,6 +108,10 @@ poe lint
 
 ## Changelog
 
+### 1.5.0
+
+Added `CheckDocumentationHeaders`, `CheckDocumentationDescriptions`, `CheckDocumentationLinks` checks that verifies that documentation file follow standard template.
+
 ### 1.4.0
 
 Added the `IntegrationTestsEnabledCheck` check that verifies if the integration tests are enabled for connectors with higher cloud usage.

airbyte-ci/connectors/connectors_qa/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connectors-qa"
-version = "1.4.0"
+version = "1.5.0"
 description = "A package to run QA checks on Airbyte connectors, generate reports and documentation."
 authors = ["Airbyte <contact@airbyte.io>"]
 readme = "README.md"

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/doc_templates/changelog.txt

@@ -0,0 +1,3 @@
+<details>
+  <summary>Expand to review</summary>
+</details>

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/doc_templates/for_airbyte_cloud.txt

@@ -0,0 +1,5 @@
+
+1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
+2. Click Sources and then click + New source.
+3. On the Set up the source page, select {connector_name} from the Source type dropdown.
+4. Enter a name for the {connector_name} connector.

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/doc_templates/for_airbyte_open_source.txt

@@ -0,0 +1,2 @@
+
+1. Navigate to the Airbyte Open Source dashboard.

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/doc_templates/source.txt

@@ -0,0 +1,6 @@
+
+<HideInUI>
+
+This page contains the setup guide and reference information for the [{connector_name}]({docs_link}) source connector.
+
+</HideInUI>

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/doc_templates/supported_sync_modes.txt

@@ -0,0 +1,2 @@
+
+The {connector_name} source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):

airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/doc_templates/tutorials.txt

@@ -0,0 +1,2 @@
+
+Now that you have set up the {connector_name} source connector, check out the following {connector_name} tutorials: