Merge Typescript API into eclipse-zenoh

.github/workflows/check-labels.yaml

@@ -0,0 +1,15 @@
+name: Check required labels
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened, labeled]
+    branches: ["**"]
+
+jobs:
+  check-labels:
+    name: Check PR labels
+    uses: eclipse-zenoh/ci/.github/workflows/check-labels.yml@main
+    secrets:
+      github-token: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      pull-requests: write

.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+#
+# Copyright (c) 2022 ZettaScale Technology
+#
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+# which is available at https://www.apache.org/licenses/LICENSE-2.0.
+#
+# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+#
+# Contributors:
+#   ZettaScale Zenoh Team, <[email protected]>
+#
+name: Build TS and Plugin
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    branches:
+      - "**"
+  schedule:
+    - cron: "0 6 * * 1-5"
+
+jobs:
+  build-rs:
+    name: Build Rust plugin on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/[email protected]
+      - name: Install Rust toolchain
+        run: |
+          rustup show
+          rustup component add rustfmt clippy
+      - name: Code format check
+        run: cargo fmt --check -- --config "unstable_features=true,imports_granularity=Crate,group_imports=StdExternalCrate"
+      - name: Clippy
+        run: cargo clippy --all --examples -- -D warnings
+      - name: Build
+        run: cargo build --all-targets
+      - name: Run tests
+        run: cargo test
+      - name: Cleanup
+        run: cargo clean
+
+  build-ts:
+    name: Build TS API on ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        working-directory: ./zenoh-ts
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '21'
+
+      - name: Run install
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: install
+          dir: 'zenoh-ts' 
+
+      - name: Transpile Library
+        run: |
+          yarn run build
+
+  # NOTE: In GitHub repository settings, the "Require status checks to pass
+  # before merging" branch protection rule ensures that commits are only merged
+  # from branches where specific status checks have passed. These checks are
+  # specified manually as a list of workflow job names. Thus we use this extra
+  # job to signal whether all CI checks have passed.
+  ci:
+    name: CI status checks
+    runs-on: ubuntu-latest
+    needs: [build-rs, build-ts]
+    if: always()
+    steps:
+      - name: Check whether all jobs pass
+        run: echo '${{ toJson(needs) }}' | jq -e 'all(.result == "success")'

.github/workflows/package-ts.yaml

@@ -0,0 +1,81 @@
+name: Package zenoh-ts
+
+on:
+  workflow_dispatch:
+    inputs:
+      publish:
+        description: 'Publish artifacts'
+        default: false
+        required: false
+        type: boolean
+      version:
+        description: 'Library version'
+        required: false
+        default: '0.0.1'
+        type: string
+      zenoh_version:
+        description: 'Zenoh version'
+        required: true
+        type: string
+        default: '1.0.0-alpha.6'
+  push: 
+
+defaults:
+  run:
+    shell: bash
+    working-directory: ./zenoh-ts
+
+jobs:
+  package:
+    name: Package app for ${{ matrix.job.name }}
+    env:
+      NUXT_PUBLIC_VERSION: ${{ inputs.version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        job:
+          - { name: 'Ubuntu x64', os: 'ubuntu-22.04', arch: X64 }
+    runs-on: ['self-hosted', '${{ matrix.job.os }}', '${{ matrix.job.arch }}']
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: git config
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://npm.pkg.github.com/
+
+      - name: Run install
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: install 
+          dir: ./zenoh-ts
+
+      - name: Transpile Code
+        run: yarn run build
+
+      - name: Publish
+        id: publish
+        shell: bash
+        env:
+          YARN_NPM_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          npm install
+          npx release-it
+
+      - name: Cleanup
+        if: always()
+        run: |
+          rm -rf node_modules
+          rm -rf dist
+          rm -rf package-lock.json

.github/workflows/publish-docs.yaml

@@ -0,0 +1,35 @@
+name: "typedoc"
+
+on:
+  push:
+    branches: [docs]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - run: cd zenoh-ts && yarn install
+      # Generate your TypeDoc documentation
+      - run: cd zenoh-ts && npx typedoc src/index.ts
+      # https://github.com/actions/upload-pages-artifact
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./zenoh-ts/docs  # This should be your TypeDoc "out" path.
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        # https://github.com/actions/deploy-pages
+        uses: actions/deploy-pages@v2

.github/workflows/release-plugin.yaml

@@ -0,0 +1,62 @@
+name: Release
+
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - v[0-9]+.*
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: taiki-e/create-gh-release-action@v1
+        with:
+          # (optional) Path to changelog.
+          changelog: CHANGELOG.md
+          # (required) GitHub token for creating GitHub Releases.
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  upload-assets:
+    needs: create-release
+    strategy:
+      matrix:
+        include:
+          - target: x86_64-unknown-linux-gnu
+            os: ubuntu-latest
+            features: systemd,io_uring
+          - target: x86_64-apple-darwin
+            os: macos-latest
+          - target: x86_64-pc-windows-msvc
+            os: windows-latest
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: taiki-e/upload-rust-binary-action@v1
+        with:
+          # (required) Comma-separated list of binary names (non-extension portion of filename) to build and upload.
+          # Note that glob pattern is not supported yet.
+          bin:
+            [
+              'zenoh_plugin_remote_api.dll',
+              'libzenoh_plugin_remote_api.so',
+              'libzenoh_plugin_remote_api.dylib'
+            ]
+          # (optional) Target triple, default is host triple.
+          target: ${{ matrix.target }}
+          # (optional) On which platform to distribute the `.tar.gz` file.
+          # [default value: unix]
+          # [possible values: all, unix, windows, none]
+          tar: unix
+          # (optional) On which platform to distribute the `.zip` file.
+          # [default value: windows]
+          # [possible values: all, unix, windows, none]
+          zip: windows
+          # (optional) Build with the given set of features if any.
+          features: ${{ matrix.features || '' }}
+          # (required) GitHub token for uploading assets to GitHub Releases.
+          token: ${{ secrets.GITHUB_TOKEN }}