feat: support native 4.1.1.22 (#1119)

* chore: wip * chore: wip * chore: wip * [AUTO] Generate codes by terra (#1121) Co-authored-by: LichKing-2234 <[email protected]> * chore: wip * chore: wip * [AUTO] Update dependencies (#1120) Co-authored-by: LichKing-2234 <[email protected]> --------- Co-authored-by: sda-rob <[email protected]> Co-authored-by: LichKing-2234 <[email protected]>
AgoraIO-Extensions · Nov 24, 2023 · e602709 · e602709
1 parent b4b9429
commit e602709
Show file tree

Hide file tree

Showing 28 changed files with 416 additions and 182 deletions.
diff --git a/.github/actions/doc/action.yml b/.github/actions/doc/action.yml
@@ -1,25 +1,31 @@
 name: Doc
-description: Generate comments
+description: Generate comments.
 
 inputs:
-  target-path:
-    description: The path to generate comments, if set, will skip clone & pr
-    default: ""
   github-token:
-    description: The github token
+    description: >
+      GITHUB_TOKEN (permissions contents: write and pull-requests: write) or a repo scoped Personal Access Token (PAT).
     required: true
 
+  target-repo:
+    description: Relative path under GITHUB_WORKSPACE to the repository.
+
+  target-branch:
+    description: Sets the pull request base branch.
+
 runs:
   using: composite
   steps:
     - name: Generate comments
       uses: AgoraIO-Extensions/actions/.github/actions/doc@main
       with:
-        target-repo: ${{ github.repository }}
-        target-branch: ${{ github.ref_name }}
-        target-path: ${{ inputs.target-path }}
+        github-token: ${{ inputs.github-token }}
+        target-repo: ${{ inputs.target-repo }}
+        target-branch: ${{ inputs.target-branch }}
         config: fmt_config/fmt_ts.yaml
         language: ts
         base-template-url: https://github.com/AgoraIO/agora_doc_source/releases/download/master-build/electron_ng_json_template_en.json
         export-file-path: ts/AgoraSdk.ts
-        github-token: ${{ inputs.github-token }}
+        pre-pr-command: |
+          rm -rf iris-doc
+          yarn lint --fix
diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml
@@ -9,6 +9,16 @@ runs:
       with:
         node-version-file: .nvmrc
 
+    - name: Setup Yarn
+      run:
+        npm i -g [email protected]
+      shell: bash
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11.5
+
     - name: Cache dependencies
       id: yarn-cache
       uses: actions/cache@v3

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,5 +1,9 @@
 name: Build API Example / Addon
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   workflow_call:
     inputs:
@@ -20,15 +24,93 @@ on:
           - sdk
   release:
     types: [ published ]
+  pull_request:
+    types: [labeled, synchronize]
 
 jobs:
-  build:
+  build-jenkins:
+    if: ${{ inputs.type == 'sdk' || (github.event_name == 'release' && github.event.action == 'published') }}
     runs-on: ubuntu-latest
     steps:
       - name: Build
         run: |
-          type=${{inputs.type}}
-          type=${type:-"sdk"}
           curl -X POST -sS -D- -o/dev/null ${{secrets.JENKINS_BUILD_URL}} \
           -H 'Content-Type: application/json' \
-          -d "{\"branch\": \"${{github.ref_name}}\", \"type\": \"${type}\"}"
+          -d "{\"branch\": \"${{github.ref_name}}\", \"type\": \"sdk\"}"
+
+  build-windows:
+    if: ${{ inputs.type == 'demo' || contains(github.event.pull_request.labels.*.name, 'ci:dep-update') }}
+    strategy:
+      matrix:
+        arch: [ ia32, x64 ]
+    runs-on: windows-latest
+    env:
+      npm_config_arch: ${{ matrix.arch }}
+      npm_config_agora_electron_arch: ${{ matrix.arch }}
+      npm_config_agora_electron_sdk_arch: ${{ matrix.arch }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Build SDK
+        run: |
+          yarn totalBuild
+          yarn zipBuild
+          yarn link
+
+      - name: Build Example
+        run: |
+          yarn install
+          yarn link agora-electron-sdk
+          yarn dist:win --${{ matrix.arch }}
+          yarn unlink agora-electron-sdk
+        working-directory: example
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: AgoraRtcNgExample-win-${{ matrix.arch }}
+          path: |
+            example/dist/Agora-Electron-API-Example-*-win.zip
+          if-no-files-found: error
+
+  build-mac:
+    if: ${{ inputs.type == 'demo' || contains(github.event.pull_request.labels.*.name, 'ci:dep-update') }}
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Build SDK
+        run: |
+          yarn totalBuild
+          yarn zipBuild
+          yarn link
+
+      - name: Build Example
+        run: |
+          yarn install
+          yarn link agora-electron-sdk
+          yarn dist:mac
+          yarn unlink agora-electron-sdk
+        env: 
+          USE_HARD_LINKS: false
+        working-directory: example
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: AgoraRtcNgExample-mac
+          path: |
+            example/dist/Agora-Electron-API-Example-*-mac.zip
+          if-no-files-found: error
+
+  notification:
+    runs-on: ubuntu-latest
+    needs: [ build-windows, build-mac ]
+    steps:
+      - run: |
+          curl -X POST "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=${{ secrets.WECHAT_KEY }}" -d '{"msgtype":"text","text":{"content":"Electron Example:\n${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\nDownload Link:\nhttps://nightly.link/${{ github.repository }}/actions/runs/${{ github.run_id }}"}}'
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -47,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -65,7 +65,7 @@ jobs:
     runs-on: ${{ matrix.runner }}-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup

diff --git a/.github/workflows/dep.yml b/.github/workflows/dep.yml
@@ -0,0 +1,29 @@
+name: Update dependencies
+
+on:
+  workflow_dispatch:
+    inputs:
+      dependencies-content:
+        description: The content of dependencies
+        required: true
+        type: string
+
+jobs:
+  update-dependencies:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Update dependencies
+        id: dep
+        uses: AgoraIO-Extensions/actions/.github/actions/dep@main
+        with:
+          github-token: ${{ secrets.GH_TOKEN }}
+          target-branch: ${{ github.ref_name }}
+          dependencies-content: ${{ inputs.dependencies-content }}          
+          target-files: |
+            package.json
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -8,9 +8,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
       - name: Generate comments
         uses: ./.github/actions/doc
         with:
           github-token: ${{ secrets.GH_TOKEN }}
+          target-branch: ${{ github.ref_name }}
diff --git a/.github/workflows/gitleaks.yml b/.github/workflows/gitleaks.yml
@@ -12,7 +12,7 @@ jobs:
     name: gitleaks
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - uses: gitleaks/gitleaks-action@v2

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -19,7 +19,7 @@ jobs:
     env:
       GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           token: ${{ secrets.GH_TOKEN }}

diff --git a/.github/workflows/terra.yml b/.github/workflows/terra.yml
@@ -13,23 +13,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
 
       - name: Generate codes
+        id: terra
         uses: AgoraIO-Extensions/actions/.github/actions/terra@main
         env:
           LLVM_DOWNLOAD_URL: |
             https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.6/clang+llvm-15.0.6-x86_64-linux-gnu-ubuntu-18.04.tar.xz
         with:
+          github-token: ${{ secrets.GH_TOKEN }}
           terra-ref: ${{ inputs.terra-ref }}
-          target-path: ${{ github.workspace }}
           config: ci/config/terra_config.yaml
           output-dir: ts/Private
           export-file-path: ts/AgoraSdk.ts
-          github-token: ${{ secrets.GH_TOKEN }}
 
       - name: Format codes
         run: |
@@ -38,22 +38,25 @@ jobs:
 
       - name: Generate ts interface
         run: |
-          yarn ts_interface_builder
+          yarn build:ts-interface
 
       - name: Generate comments
         uses: ./.github/actions/doc
         with:
-          target-path: ${{ github.workspace }}
           github-token: ${{ secrets.GH_TOKEN }}
+          target-path: ${{ github.workspace }}
 
       - name: Create pull request
         uses: AgoraIO-Extensions/actions/.github/actions/pr@main
         with:
+          github-token: ${{ secrets.GH_TOKEN }}
           target-repo: ${{ github.workspace }}
           target-branch: ${{ github.ref_name }}
-          target-branch-name-surffix: |
-            terra-update
+          target-branch-name-surffix: terra-update
           pull-request-title: |
-            [AUTO] Generate code by terra
+            [AUTO] Generate codes by terra
+          pull-request-body: |
+            Terra configuration:
+
+            ${{ steps.terra.outputs.configuration }}
           add-paths: ts
-          github-token: ${{ secrets.GH_TOKEN }}
diff --git a/README.md b/README.md
@@ -89,7 +89,7 @@ set `externals` property of your webpack config to `{"agora-electron-sdk": "comm
 
 - [Document](https://docs.agora.io/en/video-call-4.x/API%20Reference/electron_ng/API/rtc_api_overview_ng.html) - Official document
 
-- [Demo](./example/) - A quick start demo based on Vue/React and this repo
+- [Demo](./example/) - A quick start demo based on React and this repo
 
 - [Changelog](./CHANGELOG.md) - Attention to newest information
 
@@ -126,10 +126,10 @@ $ npm install #or yarn
 $ npm install --agora_electron_sdk_pre_built=false
 
 # build  32 bit architecture on Windows
-$ npm install --verbose --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=ia32
+$ npm install --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=ia32
 
 # build  64 bit architecture on Windows
-$ npm install --verbose --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=x64
+$ npm install --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=x64
 ```
 
 ## 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/AgoraIO-Extensions/Electron-SDK/pulls)

diff --git a/ci/config/terra_config.yaml b/ci/config/terra_config.yaml
@@ -1,4 +1,4 @@
-include: shared:rtc_4.1.1.16/shared_configs.yaml
+include: shared:rtc_4.1.1.22/shared_configs.yaml
 
 language: ts
 

diff --git a/ci/electron-sdk-build-mac-release.sh b/ci/electron-sdk-build-mac-release.sh
@@ -8,12 +8,12 @@ npm config set ELECTRON_MIRROR http://npm.taobao.org/mirrors/electron/
 rm -rf node_modules
 rm -rf sdk
 rm -rf tmp
-# npm install --verbose
+# npm install
 #
 # Example 2
 npm config set agora_electron_sdk_pre_built false
-npm install --verbose
-npm run totalBuild --verbose
+npm install
+npm run totalBuild
 npm run zipBuild
 npm config delete agora_electron_sdk_pre_built
 #

diff --git a/ci/electron-sdk-build-windows-release.bat b/ci/electron-sdk-build-windows-release.bat
@@ -6,13 +6,13 @@ call npm config list
 call npm config set agora_electron_sdk_pre_built false
 if %1 == ia32 (
     echo sdk_ia32
-    call npm install --verbose --agora_electron_sdk_arch=ia32
-    call npm run totalBuild --verbose --agora_electron_sdk_arch=ia32
+    call npm install --agora_electron_sdk_arch=ia32
+    call npm run totalBuild --agora_electron_sdk_arch=ia32
 )
 if %1 == x64 (
     echo sdk_x64
-    call npm install --verbose --agora_electron_sdk_arch=x64
-    call npm run totalBuild --verbose --agora_electron_sdk_arch=x64
+    call npm install --agora_electron_sdk_arch=x64
+    call npm run totalBuild --agora_electron_sdk_arch=x64
 )
 call npm config delete agora_electron_sdk_pre_built
 

diff --git a/ci/packager-mac.sh b/ci/packager-mac.sh
@@ -41,9 +41,7 @@ packExample() {
   export USE_HARD_LINKS=false
   yarn dist:mac
 
-  pushd dist/mac
-  zip -ry $(pwd)/../../../${outterZipName} Agora-Electron-API-Example.app
-  popd
+  cp -f dist/Agora-Electron-API-Example-*.zip ../${outterZipName}
   popd
 }