v0.0.1 of DepthaiViewer, WIP

.cargo/config.toml

@@ -7,3 +7,19 @@ run-wasm = "run --release --package run_wasm --"
 # Some of our build.rs files only run if this is set,
 # so that we don't run them on cargo publish or on users machines.
 IS_IN_RERUN_WORKSPACE = "yes"
+
+
+# [target.x86_64-unknown-linux-gnu]
+# linker = "clang"
+# rustflags = [
+#   "-C",
+#   "link-arg=-fuse-ld=/usr/bin/mold",
+#   "-C",
+#   "split-debuginfo=unpacked",
+# ]
+# web_sys_unstable_apis is required to enable the web_sys clipboard API which egui_web uses,
+# https://rustwasm.github.io/wasm-bindgen/api/web_sys/struct.Clipboard.html
+# as well as WebGPU apis.
+# https://rustwasm.github.io/docs/wasm-bindgen/web-sys/unstable-apis.html
+[target.wasm32-unknown-unknown]
+rustflags = ["--cfg=web_sys_unstable_apis"]

.github/pull_request_template.md

@@ -13,5 +13,10 @@ To get an auto-generated PR description you can put "copilot:summary" or "copilo
 ### What
 
 ### Checklist
-* [ ] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
-* [ ] I've included a screenshot or gif (if applicable)
+
+- [ ] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
+- [ ] I've included a screenshot or gif (if applicable)
+
+<!-- This line will get updated when the PR build summary job finishes. -->
+
+PR Build Summary: {{ pr-build-summary }}

.github/workflows/README.md

@@ -0,0 +1,66 @@
+# Overview
+
+Our CI workflows make heavy usage of [Reusable Workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows). These reusable workflows can then be tested manually via the `manual_dispatch.yml` workflow.
+Or integrated into CI jobs such has `on_pull_request.yml` or `on_main.yml`.
+
+By convention:
+- All reusable workflows start with the `reusable_` prefix.
+- All workflows that are triggered via `workflow_dispatch` start with the `manual_` prefix.
+- All workflows that are triggered via an event start with the `on_` prefix.
+  - `on_pull_request` is triggered on pull requests.
+  - `on_push_main` is triggered on pushes to the main branch.
+
+If you are going to be doing any editing of workflows, the
+[VS Code extension](https://marketplace.visualstudio.com/items?itemName=cschleiden.vscode-github-actions)
+for GitHub Actions is highly recommended.
+
+## Reusable Workflows
+- [reusable_checks.yml](reusable_checks.yml) - These are all the checks that run to ensure the code is formatted,
+  linted, and tested. This job produces no artifacts other than a pass/fail criteria for the build.
+  - `SAVE_CACHE` - If true, the rust cache will be saved. Generally we only do this for builds on `main`
+- [reusable_bench.yml](reusable_bench.yml) - This job runs the benchmarks to check for performance regressions.
+  - `SAVE_BENCH` - If true, then the benchmark results are saved to update https://ref.rerun.io/dev/bench/
+- [reusable_deploy_docs](reusable_deploy_docs.yml) - This job deploys the python and rust documentation to https://ref.rerun.io
+  - `PY_DOCS_VERSION_NAME` - The name to use for versioning the python docs. This should generally match the version in
+    `Cargo.toml`.
+  - `UPDATE_LATEST` - If true, then the docs will be deployed to `latest/` as well as the versioned directory.
+- [reusable_build_and_test_wheels.yml](reusable_build_and_test_wheels.yml) - This job builds the wheels, runs the
+end-to-end test, and produces a sample RRD. The artifacts are accessible via GitHub artifacts, but not otherwise
+uploaded anywhere.
+  - `MATURIN_FEATURE_FLAGS` - The feature flags to pass to maturin.
+  - `PLATFORM` - Which platform to build for: `linux`, `macos-arm`, `macos-intel`, or `windows`.
+  - `RELEASE_VERSION` - If producing a release, the version number. This must match the version in `Cargo.toml`.
+  - `RRD_ARTIFACT_NAME` - Intermediate name of the GitHub rrd artifact for passing to `reusable_upload_wheels.yml`
+  - `SAVE_CACHE` - If true, the rust cache will be saved. Generally we only do this for builds on `main`
+  - `WHEEL_ARTIFACT_NAME` - Intermediate name of the GitHub wheel artifact for passing to `reusable_upload_wheels.yml`
+- [reusable_upload_wheels.yml](reusable_upload_wheels.yml) - This job uploads the wheels to google cloud
+  - `RRD_ARTIFACT_NAME` - Intermediate name of the GitHub rrd artifact. This should match the name passed to
+    `reusable_build_and_test_wheels.yml`
+  - `WHEEL_ARTIFACT_NAME` - Intermediate name of the GitHub wheel artifact. This should match the name passed to
+    `reusable_build_and_test_wheels.yml`
+- [reusable_build_web.yml](reusable_build_web.yml) - This job builds the wasm artifacts for the web.
+  - `RELEASE_VERSION` - If producing a release, the version number. This must match the version in `Cargo.toml`.
+- [reusable_upload_web.yml](reusable_upload_web.yml) - This job uploads the web assets to google cloud. By default this
+  only uploads to: `app.rerun.io/commit/<commit>/`
+  - `MARK_PRERELEASE_FOR_MAINLINE` - If true, then the web assets will go to `app.rerun.io/preleease/
+  - `MARK_TAGGED_VERSION` - If true, then the web assets will go to `app.rerun.io/version/<RELEASE_VERSION>`
+  - `RELEASE_VERSION` - If producing a release, the version number.
+  - `RRD_ARTIFACT_NAME` - Intermediate name of the GitHub rrd artifact. This should match the name passed to
+    `reusable_build_and_test_wheels.yml`
+  - `UPLOAD_COMMIT_OVERRIDE` - If set, will replace the value of `<commit>`. This is necessary because we want pull
+  request builds associated with their originating commit, even if the web-build happens on an ephemeral merge-commit.
+- [reusable_pr_summary.yml](reusable_pr_summary.yml) - This job updates the PR summary with the results of the CI run.
+  - This summary can be found at:
+  `https://build.rerun.io/pr/<PR_NUMBER>/`
+  - `PR_NUMBER` - The PR number to update. This will generally be set by the `on_pull_request.yml` workflow using:
+  `${{github.event.pull_request.number}}`
+
+## Manual Workflows
+- [manual_dispatch](manual_dispatch.yml) - This workflow is used to manually trigger the assorted reusable workflows for
+  testing.
+  - See the workflow file for the list of parameters.
+- [manual_build_wheels_for_pr.yml](manual_build_wheels_for_pr.yml) - This workflow can be dispatched on a branch and
+  will build all of the wheels for the associated pull-request. Uses:
+  - [reusable_build_and_test_wheels.yml](reusable_build_and_test_wheels.yml)
+  - [reusable_upload_wheels.yml](reusable_upload_wheels.yml)
+  - [reusable_pr_summary.yml](reusable_pr_summary.yml)

.github/workflows/manual_adhoc_web.yml

@@ -0,0 +1,48 @@
+name: Run an adhoc web build
+
+on:
+  workflow_dispatch:
+    inputs:
+      EXTRA_FLAGS:
+        type: string
+        description: 'Extra flags to pass to `re_build_web_viewer`'
+        required: false
+        default: ''
+      ADHOC_NAME:
+        type: string
+        description: 'Name of the stored adhoc build'
+        required: true
+
+jobs:
+
+  min-test-wheel:
+    name: 'Minimum Test Wheel'
+    # The upload-web job uses the min-test-wheel to get the RRD
+    uses: ./.github/workflows/reusable_build_and_test_wheels.yml
+    with:
+      CONCURRENCY: adhoc-web-${{ github.event.inputs.ADHOC_NAME }}
+      PLATFORM: linux
+      MATURIN_FEATURE_FLAGS: '--no-default-features --features extension-module'
+      WHEEL_ARTIFACT_NAME: ''
+      RRD_ARTIFACT_NAME: linux-rrd-fast
+    secrets: inherit
+
+  build-web-adhoc:
+    name: 'Build Web'
+    uses: ./.github/workflows/reusable_build_web.yml
+    with:
+      CONCURRENCY: adhoc-web-${{ github.event.inputs.ADHOC_NAME }}
+      EXTRA_FLAGS: ${{ github.event.inputs.EXTRA_FLAGS }}
+    secrets: inherit
+
+  upload-web:
+    name: 'Upload Web'
+    needs: [min-test-wheel, build-web-adhoc]
+    uses: ./.github/workflows/reusable_upload_web.yml
+    with:
+      CONCURRENCY: adhoc-web-${{ github.event.inputs.ADHOC_NAME }}
+      MARK_PRERELEASE_FOR_MAINLINE: false
+      MARK_TAGGED_VERSION: false
+      ADHOC_NAME: ${{ github.event.inputs.ADHOC_NAME }}
+      RRD_ARTIFACT_NAME: linux-rrd-fast
+    secrets: inherit

.github/workflows/manual_build_wheels_for_pr.yml

@@ -0,0 +1,129 @@
+name: Build and Upload Wheels for PR
+
+on:
+  workflow_dispatch:
+
+jobs:
+
+  check-for-pr:
+    runs-on: ubuntu-latest
+    outputs:
+      PR_NUMBER: ${{ steps.get_pr.outputs.PR_NUMBER }}
+    steps:
+      - name: Check if commit belongs to a PR
+        id: get_pr
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          pr_number=$(curl --silent --header "Authorization: Bearer ${GITHUB_TOKEN}" \
+            --url "https://api.github.com/repos/${GITHUB_REPOSITORY}/commits/${GITHUB_SHA}/pulls" \
+            | jq '.[] | .number')
+
+          if [ -z "$pr_number" ]; then
+            echo "No PR associated with this commit"
+            exit 1
+          else
+            echo "Commit is associated with PR: $pr_number"
+            echo "PR_NUMBER=$pr_number" >> "$GITHUB_OUTPUT"
+          fi
+
+  build-linux:
+    needs: [check-for-pr]
+    name: 'Linux: Build/Test Wheels'
+    uses: ./.github/workflows/reusable_build_and_test_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels-linux-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      PLATFORM: linux
+      WHEEL_ARTIFACT_NAME: linux-wheel
+      RRD_ARTIFACT_NAME: linux-rrd
+    secrets: inherit
+
+  build-windows:
+    needs: [check-for-pr]
+    name: 'Windows: Build/Test Wheels'
+    uses: ./.github/workflows/reusable_build_and_test_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels-windows-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      PLATFORM: windows
+      WHEEL_ARTIFACT_NAME: windows-wheel
+      RRD_ARTIFACT_NAME: ''
+    secrets: inherit
+
+  build-macos-arm:
+    needs: [check-for-pr]
+    name: 'Macos-Arm: Build/Test Wheels'
+    uses: ./.github/workflows/reusable_build_and_test_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels-macos-arm-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      PLATFORM: macos-arm
+      WHEEL_ARTIFACT_NAME: macos-arm-wheel
+      RRD_ARTIFACT_NAME: ''
+    secrets: inherit
+
+  build-macos-intel:
+    needs: [check-for-pr]
+    name: 'Macos-Intel: Build/Test Wheels'
+    uses: ./.github/workflows/reusable_build_and_test_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels-macos-intel-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      PLATFORM: macos-intel
+      WHEEL_ARTIFACT_NAME: 'macos-intel-wheel'
+      RRD_ARTIFACT_NAME: ''
+    secrets: inherit
+
+  upload-wheels-linux:
+    name: 'Linux: Upload Wheels'
+    needs: [build-linux]
+    uses: ./.github/workflows/reusable_upload_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels-linux-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      WHEEL_ARTIFACT_NAME: linux-wheel
+      RRD_ARTIFACT_NAME: linux-rrd
+    secrets: inherit
+
+  upload-wheels-windows:
+    name: 'Windows: Upload Wheels'
+    needs: [build-linux, build-windows]
+    uses: ./.github/workflows/reusable_upload_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels-windows-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      WHEEL_ARTIFACT_NAME: windows-wheel
+      RRD_ARTIFACT_NAME: linux-rrd
+    secrets: inherit
+
+  upload-wheels-macos-arm:
+    name: 'Macos-Arm: Upload Wheels'
+    needs: [build-linux, build-macos-arm]
+    uses: ./.github/workflows/reusable_upload_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels--macos-arm-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      WHEEL_ARTIFACT_NAME: macos-arm-wheel
+      RRD_ARTIFACT_NAME: linux-rrd
+    secrets: inherit
+
+  upload-wheels-macos-intel:
+    name: 'Macos-Intel: Upload Wheels'
+    needs: [build-linux, build-macos-intel]
+    uses: ./.github/workflows/reusable_upload_wheels.yml
+    with:
+      CONCURRENCY: manual-wheels-macos-intel-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      WHEEL_ARTIFACT_NAME: macos-intel-wheel
+      RRD_ARTIFACT_NAME: linux-rrd
+    secrets: inherit
+
+  generate-wheel-index:
+    name: 'Generate Pip Index'
+    needs: [check-for-pr, upload-wheels-linux, upload-wheels-windows, upload-wheels-macos-arm, upload-wheels-macos-intel]
+    uses: ./.github/workflows/reusable_pip_index.yml
+    with:
+      CONCURRENCY: manual-wheels-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+    secrets: inherit
+
+  update-pr-summary:
+    name: 'Update PR Summary'
+    needs: [check-for-pr, upload-wheels-linux, upload-wheels-windows, upload-wheels-macos-arm, upload-wheels-macos-intel]
+    uses: ./.github/workflows/reusable_pr_summary.yml
+    with:
+      CONCURRENCY: manual-wheels-${{ needs.check-for-pr.outputs.PR_NUMBER }}
+      PR_NUMBER: ${{ needs.check-for-pr.outputs.PR_NUMBER}}
+    secrets: inherit