From cb08d70ab525a0f2e8a29aa6aa3425e2744d2e34 Mon Sep 17 00:00:00 2001 From: josix Date: Wed, 29 Jan 2025 04:30:33 +0800 Subject: [PATCH] refactor(providers/github): move github provider to new structure --- .github/boring-cyborg.yml | 5 +- docs/.gitignore | 1 + .../changelog.rst | 25 --- providers/github/README.rst | 62 ++++++ .../docs}/.latest-doc-only-change.txt | 0 .../docs/changelog.rst} | 0 .../github/docs}/commits.rst | 0 .../github/docs}/connections/github.rst | 0 .../github/docs}/index.rst | 0 .../installing-providers-from-sources.rst | 0 .../github/docs}/operators/index.rst | 8 +- .../github/docs}/security.rst | 0 .../providers => }/github/provider.yaml | 4 - providers/github/pyproject.toml | 78 +++++++ .../src/airflow/providers/github/LICENSE | 201 ++++++++++++++++++ .../src/airflow/providers/github/__init__.py | 0 .../providers/github/get_provider_info.py | 75 +++++++ .../providers/github/hooks/__init__.py | 0 .../airflow/providers/github/hooks/github.py | 3 +- .../providers/github/operators/__init__.py | 0 .../providers/github/operators/github.py | 3 +- .../providers/github/sensors/__init__.py | 0 .../providers/github/sensors/github.py | 3 +- providers/github/tests/conftest.py | 32 +++ .../github/tests/provider_tests/__init__.py | 17 ++ .../tests/provider_tests}/github/__init__.py | 0 .../provider_tests}/github/hooks/__init__.py | 0 .../github/hooks/test_github.py | 0 .../github/operators/__init__.py | 0 .../github/operators/test_github.py | 0 .../github/sensors/__init__.py | 0 .../github/sensors/test_github.py | 0 .../tests/system/github/__init__.py | 0 .../tests/system/github/example_github.py | 3 +- pyproject.toml | 3 + scripts/ci/docker-compose/remove-sources.yml | 1 + scripts/ci/docker-compose/tests-sources.yml | 1 + 37 files changed, 480 insertions(+), 45 deletions(-) delete mode 100644 docs/apache-airflow-providers-github/changelog.rst create mode 100644 providers/github/README.rst rename providers/{src/airflow/providers/github => github/docs}/.latest-doc-only-change.txt (100%) rename providers/{src/airflow/providers/github/CHANGELOG.rst => github/docs/changelog.rst} (100%) rename {docs/apache-airflow-providers-github => providers/github/docs}/commits.rst (100%) rename {docs/apache-airflow-providers-github => providers/github/docs}/connections/github.rst (100%) rename {docs/apache-airflow-providers-github => providers/github/docs}/index.rst (100%) rename {docs/apache-airflow-providers-github => providers/github/docs}/installing-providers-from-sources.rst (100%) rename {docs/apache-airflow-providers-github => providers/github/docs}/operators/index.rst (90%) rename {docs/apache-airflow-providers-github => providers/github/docs}/security.rst (100%) rename providers/{src/airflow/providers => }/github/provider.yaml (96%) create mode 100644 providers/github/pyproject.toml create mode 100644 providers/github/src/airflow/providers/github/LICENSE rename providers/{ => github}/src/airflow/providers/github/__init__.py (100%) create mode 100644 providers/github/src/airflow/providers/github/get_provider_info.py rename providers/{ => github}/src/airflow/providers/github/hooks/__init__.py (100%) rename providers/{ => github}/src/airflow/providers/github/hooks/github.py (99%) rename providers/{ => github}/src/airflow/providers/github/operators/__init__.py (100%) rename providers/{ => github}/src/airflow/providers/github/operators/github.py (99%) rename providers/{ => github}/src/airflow/providers/github/sensors/__init__.py (100%) rename providers/{ => github}/src/airflow/providers/github/sensors/github.py (99%) create mode 100644 providers/github/tests/conftest.py create mode 100644 providers/github/tests/provider_tests/__init__.py rename providers/{tests => github/tests/provider_tests}/github/__init__.py (100%) rename providers/{tests => github/tests/provider_tests}/github/hooks/__init__.py (100%) rename providers/{tests => github/tests/provider_tests}/github/hooks/test_github.py (100%) rename providers/{tests => github/tests/provider_tests}/github/operators/__init__.py (100%) rename providers/{tests => github/tests/provider_tests}/github/operators/test_github.py (100%) rename providers/{tests => github/tests/provider_tests}/github/sensors/__init__.py (100%) rename providers/{tests => github/tests/provider_tests}/github/sensors/test_github.py (100%) rename providers/{ => github}/tests/system/github/__init__.py (100%) rename providers/{ => github}/tests/system/github/example_github.py (99%) diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml index aa52559e5900f..a69d84cc129bc 100644 --- a/.github/boring-cyborg.yml +++ b/.github/boring-cyborg.yml @@ -194,10 +194,7 @@ labelPRBasedOnFilePath: - providers/tests/system/ftp/**/* provider:github: - - providers/src/airflow/providers/github/**/* - - docs/apache-airflow-providers-github/**/* - - providers/tests/github/**/* - - providers/tests/system/github/**/* + - providers/github/** provider:google: - providers/src/airflow/providers/google/**/* diff --git a/docs/.gitignore b/docs/.gitignore index 7df7cfec2007f..cebc908f508ec 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -24,6 +24,7 @@ apache-airflow-providers-docker apache-airflow-providers-edge apache-airflow-providers-exasol apache-airflow-providers-facebook +apache-airflow-providers-github apache-airflow-providers-http apache-airflow-providers-influxdb apache-airflow-providers-mongo diff --git a/docs/apache-airflow-providers-github/changelog.rst b/docs/apache-airflow-providers-github/changelog.rst deleted file mode 100644 index 231425db490d2..0000000000000 --- a/docs/apache-airflow-providers-github/changelog.rst +++ /dev/null @@ -1,25 +0,0 @@ - - .. Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - .. http://www.apache.org/licenses/LICENSE-2.0 - - .. Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - - .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE - OVERWRITTEN WHEN PREPARING PACKAGES. - - .. IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE - `PROVIDER_CHANGELOG_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY - -.. include:: ../../providers/src/airflow/providers/github/CHANGELOG.rst diff --git a/providers/github/README.rst b/providers/github/README.rst new file mode 100644 index 0000000000000..fae79eec7dc6d --- /dev/null +++ b/providers/github/README.rst @@ -0,0 +1,62 @@ + + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN! + + .. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE + `PROVIDER_README_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY + + +Package ``apache-airflow-providers-github`` + +Release: ``2.8.0`` + + +`GitHub `__ + + +Provider package +---------------- + +This is a provider package for ``github`` provider. All classes for this provider package +are in ``airflow.providers.github`` python package. + +You can find package information and changelog for the provider +in the `documentation `_. + +Installation +------------ + +You can install this package on top of an existing Airflow 2 installation (see ``Requirements`` below +for the minimum Airflow version supported) via +``pip install apache-airflow-providers-github`` + +The package supports the following python versions: 3.9,3.10,3.11,3.12 + +Requirements +------------ + +================== ================== +PIP package Version required +================== ================== +``apache-airflow`` ``>=2.9.0`` +``PyGithub`` ``>=2.1.1`` +================== ================== + +The changelog for the provider package can be found in the +`changelog `_. diff --git a/providers/src/airflow/providers/github/.latest-doc-only-change.txt b/providers/github/docs/.latest-doc-only-change.txt similarity index 100% rename from providers/src/airflow/providers/github/.latest-doc-only-change.txt rename to providers/github/docs/.latest-doc-only-change.txt diff --git a/providers/src/airflow/providers/github/CHANGELOG.rst b/providers/github/docs/changelog.rst similarity index 100% rename from providers/src/airflow/providers/github/CHANGELOG.rst rename to providers/github/docs/changelog.rst diff --git a/docs/apache-airflow-providers-github/commits.rst b/providers/github/docs/commits.rst similarity index 100% rename from docs/apache-airflow-providers-github/commits.rst rename to providers/github/docs/commits.rst diff --git a/docs/apache-airflow-providers-github/connections/github.rst b/providers/github/docs/connections/github.rst similarity index 100% rename from docs/apache-airflow-providers-github/connections/github.rst rename to providers/github/docs/connections/github.rst diff --git a/docs/apache-airflow-providers-github/index.rst b/providers/github/docs/index.rst similarity index 100% rename from docs/apache-airflow-providers-github/index.rst rename to providers/github/docs/index.rst diff --git a/docs/apache-airflow-providers-github/installing-providers-from-sources.rst b/providers/github/docs/installing-providers-from-sources.rst similarity index 100% rename from docs/apache-airflow-providers-github/installing-providers-from-sources.rst rename to providers/github/docs/installing-providers-from-sources.rst diff --git a/docs/apache-airflow-providers-github/operators/index.rst b/providers/github/docs/operators/index.rst similarity index 90% rename from docs/apache-airflow-providers-github/operators/index.rst rename to providers/github/docs/operators/index.rst index 448fb8dc3dc20..e8d3126f90bbc 100644 --- a/docs/apache-airflow-providers-github/operators/index.rst +++ b/providers/github/docs/operators/index.rst @@ -33,7 +33,7 @@ You can further process the result using An example of Listing all Repositories owned by a user, **client.get_user().get_repos()** can be implemented as following: -.. exampleinclude:: /../../providers/tests/system/github/example_github.py +.. exampleinclude:: /../../providers/github/tests/system/github/example_github.py :language: python :dedent: 4 :start-after: [START howto_operator_list_repos_github] @@ -43,7 +43,7 @@ An example of Listing all Repositories owned by a user, **client.get_user().get_ An example of Listing Tags in a Repository, **client.get_repo(full_name_or_id='apache/airflow').get_tags()** can be implemented as following: -.. exampleinclude:: /../../providers/tests/system/github/example_github.py +.. exampleinclude:: /../../providers/github/tests/system/github/example_github.py :language: python :dedent: 4 :start-after: [START howto_operator_list_tags_github] @@ -64,7 +64,7 @@ a Tag in `GitHub `__. An example for tag **v1.0**: -.. exampleinclude:: /../../providers/tests/system/github/example_github.py +.. exampleinclude:: /../../providers/github/tests/system/github/example_github.py :language: python :dedent: 4 :start-after: [START howto_tag_sensor_github] @@ -73,7 +73,7 @@ An example for tag **v1.0**: Similar Functionality can be achieved by directly using :class:`~from airflow.providers.github.sensors.github.GithubSensor`. -.. exampleinclude:: /../../providers/tests/system/github/example_github.py +.. exampleinclude:: /../../providers/github/tests/system/github/example_github.py :language: python :dedent: 4 :start-after: [START howto_sensor_github] diff --git a/docs/apache-airflow-providers-github/security.rst b/providers/github/docs/security.rst similarity index 100% rename from docs/apache-airflow-providers-github/security.rst rename to providers/github/docs/security.rst diff --git a/providers/src/airflow/providers/github/provider.yaml b/providers/github/provider.yaml similarity index 96% rename from providers/src/airflow/providers/github/provider.yaml rename to providers/github/provider.yaml index f154c68f47df5..6087dc01f3304 100644 --- a/providers/src/airflow/providers/github/provider.yaml +++ b/providers/github/provider.yaml @@ -22,10 +22,6 @@ name: Github description: | `GitHub `__ -dependencies: - - apache-airflow>=2.9.0 - - PyGithub>=2.1.1 - state: ready source-date-epoch: 1734533986 # note that those versions are maintained by release manager - do not update them manually diff --git a/providers/github/pyproject.toml b/providers/github/pyproject.toml new file mode 100644 index 0000000000000..b0e9ff3648b52 --- /dev/null +++ b/providers/github/pyproject.toml @@ -0,0 +1,78 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN! + +# IF YOU WANT TO MODIFY THIS FILE EXCEPT DEPENDENCIES, YOU SHOULD MODIFY THE TEMPLATE +# `pyproject_TEMPLATE.toml.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY +[build-system] +requires = ["flit_core==3.10.1"] +build-backend = "flit_core.buildapi" + +[project] +name = "apache-airflow-providers-github" +version = "2.8.0" +description = "Provider package apache-airflow-providers-github for Apache Airflow" +readme = "README.rst" +authors = [ + {name="Apache Software Foundation", email="dev@airflow.apache.org"}, +] +maintainers = [ + {name="Apache Software Foundation", email="dev@airflow.apache.org"}, +] +keywords = [ "airflow-provider", "github", "airflow", "integration" ] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Environment :: Web Environment", + "Intended Audience :: Developers", + "Intended Audience :: System Administrators", + "Framework :: Apache Airflow", + "Framework :: Apache Airflow :: Provider", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Topic :: System :: Monitoring", +] +requires-python = "~=3.9" + +# The dependencies should be modified in place in the generated file +# Any change in the dependencies is preserved when the file is regenerated +dependencies = [ + "apache-airflow>=2.9.0", + "PyGithub>=2.1.1", +] + +[project.urls] +"Documentation" = "https://airflow.apache.org/docs/apache-airflow-providers-github/2.8.0" +"Changelog" = "https://airflow.apache.org/docs/apache-airflow-providers-github/2.8.0/changelog.html" +"Bug Tracker" = "https://github.com/apache/airflow/issues" +"Source Code" = "https://github.com/apache/airflow" +"Slack Chat" = "https://s.apache.org/airflow-slack" +"Twitter" = "https://x.com/ApacheAirflow" +"YouTube" = "https://www.youtube.com/channel/UCSXwxpWZQ7XZ1WL3wqevChA/" + +[project.entry-points."apache_airflow_provider"] +provider_info = "airflow.providers.github.get_provider_info:get_provider_info" + +[tool.flit.module] +name = "airflow.providers.github" + +[tool.pytest.ini_options] +ignore = "tests/system/" diff --git a/providers/github/src/airflow/providers/github/LICENSE b/providers/github/src/airflow/providers/github/LICENSE new file mode 100644 index 0000000000000..11069edd79019 --- /dev/null +++ b/providers/github/src/airflow/providers/github/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/providers/src/airflow/providers/github/__init__.py b/providers/github/src/airflow/providers/github/__init__.py similarity index 100% rename from providers/src/airflow/providers/github/__init__.py rename to providers/github/src/airflow/providers/github/__init__.py diff --git a/providers/github/src/airflow/providers/github/get_provider_info.py b/providers/github/src/airflow/providers/github/get_provider_info.py new file mode 100644 index 0000000000000..37ca8ed6e950c --- /dev/null +++ b/providers/github/src/airflow/providers/github/get_provider_info.py @@ -0,0 +1,75 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN! +# +# IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE +# `get_provider_info_TEMPLATE.py.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY + + +def get_provider_info(): + return { + "package-name": "apache-airflow-providers-github", + "name": "Github", + "description": "`GitHub `__\n", + "state": "ready", + "source-date-epoch": 1734533986, + "versions": [ + "2.8.0", + "2.7.0", + "2.6.2", + "2.6.1", + "2.6.0", + "2.5.1", + "2.5.0", + "2.4.0", + "2.3.2", + "2.3.1", + "2.3.0", + "2.2.1", + "2.2.0", + "2.1.0", + "2.0.0", + "1.0.3", + "1.0.2", + "1.0.1", + "1.0.0", + ], + "integrations": [ + { + "integration-name": "Github", + "external-doc-url": "https://www.github.com/", + "tags": ["software"], + } + ], + "hooks": [ + {"integration-name": "Github", "python-modules": ["airflow.providers.github.hooks.github"]} + ], + "operators": [ + {"integration-name": "Github", "python-modules": ["airflow.providers.github.operators.github"]} + ], + "sensors": [ + {"integration-name": "Github", "python-modules": ["airflow.providers.github.sensors.github"]} + ], + "connection-types": [ + { + "hook-class-name": "airflow.providers.github.hooks.github.GithubHook", + "connection-type": "github", + } + ], + "dependencies": ["apache-airflow>=2.9.0", "PyGithub>=2.1.1"], + } diff --git a/providers/src/airflow/providers/github/hooks/__init__.py b/providers/github/src/airflow/providers/github/hooks/__init__.py similarity index 100% rename from providers/src/airflow/providers/github/hooks/__init__.py rename to providers/github/src/airflow/providers/github/hooks/__init__.py diff --git a/providers/src/airflow/providers/github/hooks/github.py b/providers/github/src/airflow/providers/github/hooks/github.py similarity index 99% rename from providers/src/airflow/providers/github/hooks/github.py rename to providers/github/src/airflow/providers/github/hooks/github.py index 6be50fd31fec4..fb2b2b0416008 100644 --- a/providers/src/airflow/providers/github/hooks/github.py +++ b/providers/github/src/airflow/providers/github/hooks/github.py @@ -21,10 +21,9 @@ from typing import TYPE_CHECKING -from github import Github as GithubClient - from airflow.exceptions import AirflowException from airflow.hooks.base import BaseHook +from github import Github as GithubClient class GithubHook(BaseHook): diff --git a/providers/src/airflow/providers/github/operators/__init__.py b/providers/github/src/airflow/providers/github/operators/__init__.py similarity index 100% rename from providers/src/airflow/providers/github/operators/__init__.py rename to providers/github/src/airflow/providers/github/operators/__init__.py diff --git a/providers/src/airflow/providers/github/operators/github.py b/providers/github/src/airflow/providers/github/operators/github.py similarity index 99% rename from providers/src/airflow/providers/github/operators/github.py rename to providers/github/src/airflow/providers/github/operators/github.py index 82996d3ecedb4..3889335628d03 100644 --- a/providers/src/airflow/providers/github/operators/github.py +++ b/providers/github/src/airflow/providers/github/operators/github.py @@ -19,11 +19,10 @@ from typing import TYPE_CHECKING, Any, Callable -from github import GithubException - from airflow.exceptions import AirflowException from airflow.models import BaseOperator from airflow.providers.github.hooks.github import GithubHook +from github import GithubException if TYPE_CHECKING: try: diff --git a/providers/src/airflow/providers/github/sensors/__init__.py b/providers/github/src/airflow/providers/github/sensors/__init__.py similarity index 100% rename from providers/src/airflow/providers/github/sensors/__init__.py rename to providers/github/src/airflow/providers/github/sensors/__init__.py diff --git a/providers/src/airflow/providers/github/sensors/github.py b/providers/github/src/airflow/providers/github/sensors/github.py similarity index 99% rename from providers/src/airflow/providers/github/sensors/github.py rename to providers/github/src/airflow/providers/github/sensors/github.py index cacaef9e32fb8..b40420ce207ab 100644 --- a/providers/src/airflow/providers/github/sensors/github.py +++ b/providers/github/src/airflow/providers/github/sensors/github.py @@ -19,11 +19,10 @@ from typing import TYPE_CHECKING, Any, Callable -from github import GithubException - from airflow.exceptions import AirflowException from airflow.providers.github.hooks.github import GithubHook from airflow.sensors.base import BaseSensorOperator +from github import GithubException if TYPE_CHECKING: try: diff --git a/providers/github/tests/conftest.py b/providers/github/tests/conftest.py new file mode 100644 index 0000000000000..068fe6bbf5ae9 --- /dev/null +++ b/providers/github/tests/conftest.py @@ -0,0 +1,32 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import pathlib + +import pytest + +pytest_plugins = "tests_common.pytest_plugin" + + +@pytest.hookimpl(tryfirst=True) +def pytest_configure(config: pytest.Config) -> None: + deprecations_ignore_path = pathlib.Path(__file__).parent.joinpath("deprecations_ignore.yml") + dep_path = [deprecations_ignore_path] if deprecations_ignore_path.exists() else [] + config.inicfg["airflow_deprecations_ignore"] = ( + config.inicfg.get("airflow_deprecations_ignore", []) + dep_path # type: ignore[assignment,operator] + ) diff --git a/providers/github/tests/provider_tests/__init__.py b/providers/github/tests/provider_tests/__init__.py new file mode 100644 index 0000000000000..e8fd22856438c --- /dev/null +++ b/providers/github/tests/provider_tests/__init__.py @@ -0,0 +1,17 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/providers/tests/github/__init__.py b/providers/github/tests/provider_tests/github/__init__.py similarity index 100% rename from providers/tests/github/__init__.py rename to providers/github/tests/provider_tests/github/__init__.py diff --git a/providers/tests/github/hooks/__init__.py b/providers/github/tests/provider_tests/github/hooks/__init__.py similarity index 100% rename from providers/tests/github/hooks/__init__.py rename to providers/github/tests/provider_tests/github/hooks/__init__.py diff --git a/providers/tests/github/hooks/test_github.py b/providers/github/tests/provider_tests/github/hooks/test_github.py similarity index 100% rename from providers/tests/github/hooks/test_github.py rename to providers/github/tests/provider_tests/github/hooks/test_github.py diff --git a/providers/tests/github/operators/__init__.py b/providers/github/tests/provider_tests/github/operators/__init__.py similarity index 100% rename from providers/tests/github/operators/__init__.py rename to providers/github/tests/provider_tests/github/operators/__init__.py diff --git a/providers/tests/github/operators/test_github.py b/providers/github/tests/provider_tests/github/operators/test_github.py similarity index 100% rename from providers/tests/github/operators/test_github.py rename to providers/github/tests/provider_tests/github/operators/test_github.py diff --git a/providers/tests/github/sensors/__init__.py b/providers/github/tests/provider_tests/github/sensors/__init__.py similarity index 100% rename from providers/tests/github/sensors/__init__.py rename to providers/github/tests/provider_tests/github/sensors/__init__.py diff --git a/providers/tests/github/sensors/test_github.py b/providers/github/tests/provider_tests/github/sensors/test_github.py similarity index 100% rename from providers/tests/github/sensors/test_github.py rename to providers/github/tests/provider_tests/github/sensors/test_github.py diff --git a/providers/tests/system/github/__init__.py b/providers/github/tests/system/github/__init__.py similarity index 100% rename from providers/tests/system/github/__init__.py rename to providers/github/tests/system/github/__init__.py diff --git a/providers/tests/system/github/example_github.py b/providers/github/tests/system/github/example_github.py similarity index 99% rename from providers/tests/system/github/example_github.py rename to providers/github/tests/system/github/example_github.py index b076647177cc9..c3d1d3a4c7e4e 100644 --- a/providers/tests/system/github/example_github.py +++ b/providers/github/tests/system/github/example_github.py @@ -21,12 +21,11 @@ from datetime import datetime from typing import Any -from github import GithubException - from airflow.exceptions import AirflowException from airflow.models.dag import DAG from airflow.providers.github.operators.github import GithubOperator from airflow.providers.github.sensors.github import GithubSensor, GithubTagSensor +from github import GithubException ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID") DAG_ID = "example_github_operator" diff --git a/pyproject.toml b/pyproject.toml index 881e67766313e..c943e530a932f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -645,6 +645,7 @@ dev = [ "apache-airflow-providers-edge", "apache-airflow-providers-exasol", "apache-airflow-providers-facebook", + "apache-airflow-providers-github", "apache-airflow-providers-http", "apache-airflow-providers-influxdb", "apache-airflow-providers-mongo", @@ -710,6 +711,7 @@ apache-airflow-providers-docker = { workspace = true } apache-airflow-providers-edge = {workspace = true} apache-airflow-providers-exasol = { workspace = true } apache-airflow-providers-facebook = { workspace = true } +apache-airflow-providers-github = { workspace = true } apache-airflow-providers-http = { workspace = true } apache-airflow-providers-influxdb = { workspace = true } apache-airflow-providers-mongo = { workspace = true } @@ -773,6 +775,7 @@ members = [ "providers/edge", "providers/exasol", "providers/facebook", + "providers/github", "providers/hashicorp", "providers/http", "providers/imap", diff --git a/scripts/ci/docker-compose/remove-sources.yml b/scripts/ci/docker-compose/remove-sources.yml index ad808caa72e1c..acd9aff00de81 100644 --- a/scripts/ci/docker-compose/remove-sources.yml +++ b/scripts/ci/docker-compose/remove-sources.yml @@ -56,6 +56,7 @@ services: - ../../../empty:/opt/airflow/providers/edge/src - ../../../empty:/opt/airflow/providers/exasol/src - ../../../empty:/opt/airflow/providers/facebook/src + - ../../../empty:/opt/airflow/providers/github/src - ../../../empty:/opt/airflow/providers/hashicorp/src - ../../../empty:/opt/airflow/providers/http/src - ../../../empty:/opt/airflow/providers/imap/src diff --git a/scripts/ci/docker-compose/tests-sources.yml b/scripts/ci/docker-compose/tests-sources.yml index 6f7c2d0233ab1..846e8e2ef1974 100644 --- a/scripts/ci/docker-compose/tests-sources.yml +++ b/scripts/ci/docker-compose/tests-sources.yml @@ -63,6 +63,7 @@ services: - ../../../providers/edge/tests:/opt/airflow/providers/edge/tests - ../../../providers/exasol/tests:/opt/airflow/providers/exasol/tests - ../../../providers/facebook/tests:/opt/airflow/providers/facebook/tests + - ../../../providers/github/tests:/opt/airflow/providers/github/tests - ../../../providers/hashicorp/tests:/opt/airflow/providers/hashicorp/tests - ../../../providers/http/tests:/opt/airflow/providers/http/tests - ../../../providers/imap/tests:/opt/airflow/providers/imap/tests