Third-party component upload (#31)

* Prepare third-party deps for registry
* Create component upload workflow
* Update existing workflows
* Use registry for nanopb and khash

Author: ladvoc

.github/workflows/ci.yml

@@ -16,4 +16,8 @@ jobs:
     uses: ./.github/workflows/build_examples.yml
   license-check:
     name: License Check
-    uses: ./.github/workflows/license_check.yml
+    uses: ./.github/workflows/license_check.yml
+  registry-check:
+    name: Registry Check
+    uses: ./.github/workflows/esp_registry.yml
+    with: { dry_run: true }

.github/workflows/docs.yml

@@ -1,11 +1,11 @@
 name: Build Documentation
 on:
-  workflow_dispatch:
-  push:
-    branches: [main]
-concurrency:
-  group: "docs"
-  cancel-in-progress: true
+  workflow_call:
+    inputs:
+      deploy:
+        type: boolean
+        description: Deploy to GitHub Pages
+        default: false
 jobs:
   build-docs:
     name: Build Documentation
@@ -21,11 +21,13 @@ jobs:
       - name: Configure Pages
         uses: actions/configure-pages@v5
       - name: Upload Generated Docs
+        if: ${{ inputs.deploy }}
         uses: actions/upload-pages-artifact@v3
         with: { path: docs/output/html }
-  deploy:
+  deploy-docs:
     name: Deploy Documentation
     needs: build-docs
+    if: ${{ inputs.deploy }}
     permissions:
       pages: write
       id-token: write

.github/workflows/esp_registry.yml

@@ -0,0 +1,35 @@
+name: ESP Registry
+on:
+  workflow_call:
+    inputs:
+      dry_run:
+        type: boolean
+        description: Do not actually upload the components
+        default: true
+jobs:
+  esp_registry:
+    name: Upload Components
+    runs-on: ubuntu-latest
+    env:
+      COMPONENTS: |
+        nanopb:./components/third_party/nanopb
+        khash:./components/third_party/khash
+    steps:
+      - uses: actions/checkout@v4
+        with: { submodules: recursive }
+      - name: Upload Components (Dry Run)
+        uses: espressif/upload-components-ci-action@v2
+        if: ${{ inputs.dry_run }}
+        with:
+          components: ${{ env.COMPONENTS }}
+          namespace: livekit
+          api_token: ${{ secrets.ESP_REGISTRY_TOKEN }}
+          dry_run: true
+      - name: Upload Components
+        uses: espressif/upload-components-ci-action@v2
+        if: ${{ !inputs.dry_run }}
+        with:
+          components: ${{ env.COMPONENTS }}
+          namespace: livekit
+          api_token: ${{ secrets.ESP_REGISTRY_TOKEN }}
+          dry_run: false

.github/workflows/release.yml

@@ -0,0 +1,14 @@
+name: Release
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+jobs:
+  registry-upload:
+    name: Registry Upload
+    uses: ./.github/workflows/esp_registry.yml
+    with: { dry_run: false }
+  deploy-docs:
+    name: Deploy Documentation
+    uses: ./.github/workflows/docs.yml
+    with: { deploy: true }

components/livekit/idf_component.yml

@@ -15,9 +15,7 @@ dependencies:
   espressif/esp_peer: ~1.2.3
   media_lib_sal:
     path: ../third_party/esp-webrtc-solution/components/media_lib_sal
-  nanopb:
-    path: ../third_party/nanopb
-  khash:
-    path: ../third_party/khash
+  livekit/nanopb: ~0.4.9
+  livekit/khash: ~0.1.0
 files:
   use_gitignore: true

components/third_party/khash/README.md

@@ -0,0 +1,7 @@
+# Khash
+
+A generic hash table with open addressing from [Klib](https://github.com/attractivechaos/klib).
+
+---
+
+**Important**: This component is uploaded to the ESP Component Registry unofficially and is not affiliated with the Klib project. It is used as a dependency of the [LiveKit ESP32 SDK](https://github.com/livekit/client-sdk-esp32) and may not be regularly updated with the upstream project.

components/third_party/khash/idf_component.yml

@@ -1,3 +1,5 @@
-description: Khash (from klib)
+version: 0.1.0
+description: A generic hash table with open addressing.
+url: https://attractivechaos.github.io/klib/
 repository: https://github.com/attractivechaos/klib
 license: MIT

components/third_party/nanopb/README.md

@@ -0,0 +1,7 @@
+# Nanopb
+
+Protocol buffer library for embedded systems.
+
+---
+
+**Important**: This component is uploaded to the ESP Component Registry unofficially and is not affiliated with the Nanopb project. It is used as a dependency of the [LiveKit ESP32 SDK](https://github.com/livekit/client-sdk-esp32) and may not be regularly updated with the upstream project.

components/third_party/nanopb/idf_component.yml

@@ -1,6 +1,6 @@
-description: Nanopb
+version: 0.4.9
+description: Protocol buffer library for embedded systems.
 url: https://jpa.kapsi.fi/nanopb/
 repository: https://github.com/nanopb/nanopb/
 documentation: https://jpa.kapsi.fi/nanopb/docs/
-version: 0.4.9
 license: Zlib