Merge pull request #34 from agners/use-git-submodule

Use git submodule to reference Matter SDK

Author: agners

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "gitsubmodule"
+    directory: "/"
+    allow:
+      - dependency-name: "connectedhomeip"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build.yaml

@@ -2,9 +2,6 @@ name: CHIP wheels build
 
 on: push
 
-env:
-  matter_sdk_ref: v1.2.0.1
-
 jobs:
   build_prepare:
     name: Prepare build
@@ -16,6 +13,7 @@ jobs:
       - name: Checkout build repository
         uses: actions/checkout@v4
         with:
+          submodules: true
           fetch-depth: 0
       - name: Get version
         id: version
@@ -43,37 +41,32 @@ jobs:
           fi
           echo "Building version $version"
           echo "version=$version" >> "$GITHUB_OUTPUT"
-      - name: Checkout CHIP SDK repository
-        uses: actions/checkout@v4
-        with:
-          repository: project-chip/connectedhomeip
-          ref: ${{ env.matter_sdk_ref }}
-          path: ./project-chip
       - name: Checkout submodules
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
         run: scripts/checkout_submodules.py --shallow --platform linux
       - name: Apply patches
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
         run: |
           for patch in ../*.patch
           do
               echo "Applying ${patch}"
               patch -p1 < $patch
           done
       - name: Bootstrap
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
         run: bash scripts/bootstrap.sh -p all,linux
       - name: ZAP Code pre-generation
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
         run: scripts/run_in_build_env.sh "scripts/codepregen.py ./zzz_pregenerated/"
       - name: Create Matter SDK tar
-        working-directory: ./project-chip
-        run: tar -caf ../project-chip.tar.zst --exclude .environment --use-compress-program=zstdmt .
+        run: |
+          tar -caf ../connectedhomeip.tar.zst --exclude ./connectedhomeip/.environment --use-compress-program=zstdmt .
+          mv ../connectedhomeip.tar.zst ./connectedhomeip.tar.zst
       - name: Store Matter SDK as artifact
         uses: actions/upload-artifact@v4
         with:
           name: matter-sdk-${{ github.run_id }}
-          path: ./project-chip.tar.zst
+          path: ./connectedhomeip.tar.zst
 
   build_linux_python_lib:
     name: Build Python wheels for Linux (${{ matrix.arch.name }})
@@ -95,7 +88,7 @@ jobs:
 
     defaults:
       run:
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
 
     container:
       image: ${{ matrix.arch.container }}
@@ -112,13 +105,10 @@ jobs:
       - name: Extract Matter SDK from tar
         working-directory: ./
         run: |
-          rm -rf project-chip
-          mkdir -p project-chip
-          cd project-chip
           apt update && apt install zstd
-          tar -xaf ../project-chip.tar.zst --use-compress-program=zstdmt .
+          rm -rf connectedhomeip/
+          tar -xaf ./connectedhomeip.tar.zst --use-compress-program=zstdmt .
           git config --global --add safe.directory "*"
-          rm -rf out/
       - name: Bootstrap
         run: bash scripts/bootstrap.sh -p all,linux
       - name: Setup Build, Run Build and Run Tests
@@ -147,7 +137,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: chip-wheels-linux-${{ matrix.arch.name }}
-          path: project-chip/out/controller/python/*.whl
+          path: ./connectedhomeip/out/controller/python/*.whl
       - name: Upload wheels as release assets
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
@@ -192,32 +182,27 @@ jobs:
 
     defaults:
       run:
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
 
     steps:
       - name: Checkout build repository
         uses: actions/checkout@v4
         with:
+          submodules: true
           fetch-depth: 0
-      - name: Checkout CHIP SDK repository
-        uses: actions/checkout@v4
-        with:
-          repository: project-chip/connectedhomeip
-          ref: ${{ env.matter_sdk_ref }}
-          path: ./project-chip
       - name: Checkout submodules
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
         run: scripts/checkout_submodules.py --shallow --platform darwin
       - name: Apply patches
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
         run: |
           for patch in ../*.patch
           do
               echo "Applying ${patch}"
               patch -p1 < $patch
           done
       - name: Bootstrap
-        working-directory: ./project-chip
+        working-directory: ./connectedhomeip/
         run: bash scripts/bootstrap.sh -p all,darwin
       - name: Setup Build, Run Build and Run Tests
         run: |
@@ -249,7 +234,7 @@ jobs:
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
-          files: project-chip/out/controller/python/*.whl
+          files: connectedhomeip/out/controller/python/*.whl
       - name: Upload wheels to PyPI
         if: startsWith(github.ref, 'refs/tags/')
         env:

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "connectedhomeip"]
+	path = connectedhomeip
+	url = https://github.com/project-chip/connectedhomeip.git

README.md

@@ -1,5 +1,17 @@
-## Project Matter Python Device Controller Wheels
+## Matter Python Device Controller Wheels
+
+This repository provides the building infrastructure to build Python wheels of
+the Matter device controller. It uses the [official project Matter SDK](https://github.com/project-chip/connectedhomeip/)
+and builds the Python bindings available at `src/controller/python/`. The
+bindings use the official Matter implementation wriitten in C++ as a native
+library using ctypes bindings. The `chip-core` wheel contains this native
+library. Hence the `chip-core` wheel is a platform specific wheel.
+
+Binary wheels of (tagged) releases and pre-releases for Linux x86-64 and
+aarch64/arm64 as well as macOS aarch64/arm64 are available from our Home
+Assistant CHIP repositories at:
+
+- [home-assistant-chip-repl](https://pypi.org/project/home-assistant-chip-repl/)
+- [home-assistant-chip-core](https://pypi.org/project/home-assistant-chip-core/) (contains the native dependency)
+- [home-assistant-chip-clusters](https://pypi.org/project/home-assistant-chip-clusters/)
 
-This repository provides the building infrastructure to build Python wheels for
-the Linux platform.  It uses the [official project Matter SDK](https://github.com/project-chip/connectedhomeip/)
-to build the wheels.