You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/01/14 09:18:14 UTC

[GitHub] [airflow] TobKed commented on a change in pull request #13193: Add Prerequisites that new provider package should fulfils

TobKed commented on a change in pull request #13193:
URL: https://github.com/apache/airflow/pull/13193#discussion_r557247529



##########
File path: docs/apache-airflow-providers/index.rst
##########
@@ -224,6 +224,64 @@ Apache projects. As a community, we provide all the software for free and this w
 change. What 3rd-party developers are doing is not under control of Apache Airflow community.
 
 
+Prerequisites that new provider package should fulfill
+""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Directory structure:
+
+  .. code-block:: bash
+
+      airflow/airflow/providers/some_provider
+      ├── BACKPORT_PROVIDER_README.md
+      ├── README.md
+      ├── __init__.py
+      ├── example_dags
+      │   ├── __init__.py
+      │   └── example_some_provider.py
+      ├── hooks
+      │   ├── __init__.py
+      │   └── some_provider.py
+      ├── operators
+      │   ├── __init__.py
+      │   └── some_provider.py
+      ├── sensors
+      │   ├── __init__.py
+      │   └── some_provider.py
+      ├── transfers
+      │   ├── __init__.py
+      │   └── some_provider.py
+      └── provider.yaml
+
+      tests/providers/some_provider
+      ├── __init__.py
+      ├── hooks
+      │   ├── __init__.py
+      │   └── test_some_provider.py
+      ├── operators
+      │   ├── __init__.py
+      │   ├── test_some_provider.py
+      │   └── test_some_provider_system.py
+      ├── sensors
+      │   ├── __init__.py
+      │   └── test_some_provider.py
+      └── transfers
+          ├── __init__.py
+          └── test_some_provider.py
+
+* Add documentation in ``docs/apache-airflow-providers-some-provider/index.rst``
+
+* Update files:
+
+  * ``airflow/CONTRIBUTING.rst``:
+
+    * extras
+    * provider packages
+
+  * ``airflow/providers/dependencies.json``

Review comment:
       Updated in https://github.com/apache/airflow/pull/13193/commits/0e966708f16816f8d1215efd29e1b355fdc31582




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org