apache-airflow-multirepo-deploy 2.0.0rc4__tar.gz

apache_airflow_multirepo_deploy-2.0.0rc4/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: j178/prek-action@v1
+
+  lint-test-js:
+    name: Lint & Test JS
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: latest
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: pnpm
+          cache-dependency-path: src/airflow_multirepo_deploy/ui/pnpm-lock.yaml
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+        working-directory: src/airflow_multirepo_deploy/ui
+      - name: Lint
+        run: pnpm lint
+        working-directory: src/airflow_multirepo_deploy/ui
+      - name: Test
+        run: pnpm test
+        working-directory: src/airflow_multirepo_deploy/ui

apache_airflow_multirepo_deploy-2.0.0rc4/.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "[0-9]*"
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: pnpm/action-setup@v4
+        with:
+          version: latest
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: pnpm
+          cache-dependency-path: src/airflow_multirepo_deploy/ui/pnpm-lock.yaml
+      - uses: astral-sh/setup-uv@v5
+      - name: Build wheel and sdist
+        run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

apache_airflow_multirepo_deploy-2.0.0rc4/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+.idea/
+*.iml
+dist/
+node_modules/
+*.egg-info/
+_version.py

apache_airflow_multirepo_deploy-2.0.0rc4/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-ast
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.5
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format

apache_airflow_multirepo_deploy-2.0.0rc4/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: apache-airflow-multirepo-deploy
+Version: 2.0.0rc4
+Summary: Apache Airflow plugin for managing multi-repository DAG deployments
+License: Apache-2.0
+Requires-Python: >=3.9
+Requires-Dist: apache-airflow-core>=3.0.0
+Requires-Dist: cryptography>=45.0.0
+Requires-Dist: gitpython>=3.1.46
+Requires-Dist: pyjwt>=2.10.1
+Requires-Dist: requests>=2.31.0
+Description-Content-Type: text/markdown
+
+# Airflow Multirepo Deploy plugin
+
+Airflow plugin for deploying DAGs from multiple Git repository from Airflow webserver.
+
+The plugin scans every folder in Airflow DAGs folder (without subfolders),
+and check if it's a git repository. It's intended to be used in a scenario where DAGs are
+stored in a single shared volume. The volume must be mounted in the webserver too.
+
+It's been designed for scenarios where Airflow is deployed in a Kubernetes cluster,
+and multiple teams deploy their DAGs from separate repos.
+
+## Features
+
+* Deploy DAGs from multiple Git repos
+* See deployed commit for each environment
+* Easily switch between branches
+
+![](images/repos.png)
+![](images/deployment.png)
+
+## Installation
+
+```
+pip install apache-airflow-multirepo-deploy
+```
+
+## Usage
+
+### Airflow helm chart
+
+To use this plugin with the official Airflow helm chart, you need to configure:
+* `dags.persistence` to create a shared persistent volume
+* `webserver.extraVolumes` and `webserver.extraVolumeMounts` to mount the volume in the webserver
+
+### Configuration
+Have a look at this configuration snippet and adjust it to your needs.
+The only required part is the GitHub App configuration if you want to use GitHub App authentication.
+If you don't configure it, the plugin will fall back to using SSH keys for authentication, which is also supported out of the box.
+
+```
+[multirepo_deploy]
+# URL prefix for the deployment routes
+url_prefix = deployment
+
+# Path to the React app dist folder
+react_app_dir = /path/to/plugin/ui/dist
+
+# Optional post-deployment hook (Python callable)
+# post_hook = mymodule.my_function
+
+# Optional: restrict which branches can be deployed (comma-separated)
+# allowed_branches = origin/main,origin/develop,origin/staging
+
+# GitHub App Configuration (required for GitHub App authentication)
+# To use GitHub App authentication, you need all three of these:
+
+# 1. Your GitHub App ID (found in app settings)
+gh_app_id = 123456
+
+# 2. Base64-encoded private key for your GitHub App (PEM format)
+#    Generate this from your GitHub App settings
+gh_app_private_key = LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQo... (truncated for security)
+
+# 3. Installation ID for your organization
+#    Find this in the URL when you view the app installation:
+#    https://github.com/organizations/YOUR_ORG/settings/installations/INSTALLATION_ID
+gh_app_installation_id = 12345678
+
+# Note: If these are not configured, only SSH key method will be available
+```
+
+### Authentication
+While you should configure the Git authentication specific to your environment,
+the plugin supports multiple SSH keys (like GitHub deployment keys) out of the box.
+For a given repo , simply store the SSH key in a file `<repo_folder_name>.key`
+in the parent folder of the repo.

apache_airflow_multirepo_deploy-2.0.0rc4/Readme.md

@@ -0,0 +1,76 @@
+# Airflow Multirepo Deploy plugin
+
+Airflow plugin for deploying DAGs from multiple Git repository from Airflow webserver.
+
+The plugin scans every folder in Airflow DAGs folder (without subfolders),
+and check if it's a git repository. It's intended to be used in a scenario where DAGs are
+stored in a single shared volume. The volume must be mounted in the webserver too.
+
+It's been designed for scenarios where Airflow is deployed in a Kubernetes cluster,
+and multiple teams deploy their DAGs from separate repos.
+
+## Features
+
+* Deploy DAGs from multiple Git repos
+* See deployed commit for each environment
+* Easily switch between branches
+
+![](images/repos.png)
+![](images/deployment.png)
+
+## Installation
+
+```
+pip install apache-airflow-multirepo-deploy
+```
+
+## Usage
+
+### Airflow helm chart
+
+To use this plugin with the official Airflow helm chart, you need to configure:
+* `dags.persistence` to create a shared persistent volume
+* `webserver.extraVolumes` and `webserver.extraVolumeMounts` to mount the volume in the webserver
+
+### Configuration
+Have a look at this configuration snippet and adjust it to your needs.
+The only required part is the GitHub App configuration if you want to use GitHub App authentication.
+If you don't configure it, the plugin will fall back to using SSH keys for authentication, which is also supported out of the box.
+
+```
+[multirepo_deploy]
+# URL prefix for the deployment routes
+url_prefix = deployment
+
+# Path to the React app dist folder
+react_app_dir = /path/to/plugin/ui/dist
+
+# Optional post-deployment hook (Python callable)
+# post_hook = mymodule.my_function
+
+# Optional: restrict which branches can be deployed (comma-separated)
+# allowed_branches = origin/main,origin/develop,origin/staging
+
+# GitHub App Configuration (required for GitHub App authentication)
+# To use GitHub App authentication, you need all three of these:
+
+# 1. Your GitHub App ID (found in app settings)
+gh_app_id = 123456
+
+# 2. Base64-encoded private key for your GitHub App (PEM format)
+#    Generate this from your GitHub App settings
+gh_app_private_key = LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQo... (truncated for security)
+
+# 3. Installation ID for your organization
+#    Find this in the URL when you view the app installation:
+#    https://github.com/organizations/YOUR_ORG/settings/installations/INSTALLATION_ID
+gh_app_installation_id = 12345678
+
+# Note: If these are not configured, only SSH key method will be available
+```
+
+### Authentication
+While you should configure the Git authentication specific to your environment,
+the plugin supports multiple SSH keys (like GitHub deployment keys) out of the box.
+For a given repo , simply store the SSH key in a file `<repo_folder_name>.key`
+in the parent folder of the repo.

apache_airflow_multirepo_deploy-2.0.0rc4/hatch_build.py

@@ -0,0 +1,13 @@
+import subprocess
+from pathlib import Path
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CustomBuildHook(BuildHookInterface):
+    PLUGIN_NAME = "ui_build"
+
+    def initialize(self, version, build_data):
+        ui_dir = Path(self.root) / "src" / "airflow_multirepo_deploy" / "ui"
+        subprocess.run(["pnpm", "install", "--frozen-lockfile"], cwd=ui_dir, check=True)
+        subprocess.run(["pnpm", "build"], cwd=ui_dir, check=True)

apache_airflow_multirepo_deploy-2.0.0rc4/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "apache-airflow-multirepo-deploy"
+dynamic = ["version"]
+description = "Apache Airflow plugin for managing multi-repository DAG deployments"
+readme = "Readme.md"
+license = { text = "Apache-2.0" }
+requires-python = ">=3.9"
+dependencies = [
+    "apache-airflow-core>=3.0.0",
+    "GitPython>=3.1.46",
+    "PyJWT>=2.10.1",
+    "cryptography>=45.0.0",
+    "requests>=2.31.0",
+]
+
+[project.entry-points."airflow.plugins"]
+multirepo_deploy = "airflow_multirepo_deploy:AirflowMultiRepoDeploymentPlugin"
+
+[tool.hatch.version]
+source = "vcs"
+raw-options = { tag_regex = "^(?P<version>[0-9]+\\..*)" }
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/airflow_multirepo_deploy/_version.py"
+
+[tool.hatch.build.hooks.custom]
+path = "hatch_build.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/airflow_multirepo_deploy"]
+artifacts = [
+    "src/airflow_multirepo_deploy/ui/dist/**",
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["src/airflow_multirepo_deploy/ui/node_modules"]
+
+[tool.ruff]
+line-length = 120

apache_airflow_multirepo_deploy-2.0.0rc4/src/airflow_multirepo_deploy/__init__.py

@@ -0,0 +1,3 @@
+from airflow_multirepo_deploy.plugin import AirflowMultiRepoDeploymentPlugin
+
+__all__ = ["AirflowMultiRepoDeploymentPlugin"]

apache_airflow_multirepo_deploy-2.0.0rc4/src/airflow_multirepo_deploy/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '2.0.0rc4'
+__version_tuple__ = version_tuple = (2, 0, 0, 'rc4')
+
+__commit_id__ = commit_id = None