Prepare release of 0.7.0

.github/pull_request_template.md

@@ -18,3 +18,5 @@ To get an auto-generated PR description you can put "copilot:summary" or "copilo
 
 <!-- This line will get updated when the PR build summary job finishes. -->
 PR Build Summary: {{ pr-build-summary }}
+
+<!-- This comment will be replaced by a link to the documentation preview -->

.github/workflows/documentation.yaml

@@ -0,0 +1,35 @@
+name: Documentation
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+
+permissions:
+  contents: read
+
+jobs:
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: streetsidesoftware/cspell-action@v2
+        with:
+          config: "docs/cspell.json"
+          files: "docs/**/*.md"
+  linkinator:
+    name: linkinator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: jprochazk/linkinator-action@main
+        with:
+          paths: "docs/**/*.md"
+          linksToSkip: "https://crates.io/crates/rerun"
+          retry: true
+          retryErrors: true
+          retryErrorsCount: 5
+          retryErrorsJitter: 2000
+

.github/workflows/manual_adhoc_web.yml

@@ -45,6 +45,7 @@ jobs:
       MARK_TAGGED_VERSION: false
       ADHOC_NAME: ${{ github.event.inputs.ADHOC_NAME }}
       RRD_ARTIFACT_NAME: linux-rrd-fast
+      UPLOAD_COMMIT: false
     secrets: inherit
 
   build-web-demo-adhoc:
@@ -65,4 +66,5 @@ jobs:
       MARK_PRERELEASE_FOR_MAINLINE: false
       MARK_TAGGED_VERSION: false
       ADHOC_NAME: ${{ github.event.inputs.ADHOC_NAME }}
+      UPLOAD_COMMIT: false
     secrets: inherit

.github/workflows/manual_build_release.yml

@@ -113,6 +113,26 @@ jobs:
       RRD_ARTIFACT_NAME: linux-rrd
       RELEASE_VERSION: ${{ github.event.inputs.RELEASE_VERSION }}
     secrets: inherit
+
+  build-web-demo:
+    name: 'Build Web Demo'
+    needs: [build-linux, build-web]
+    uses: ./.github/workflows/reusable_build_web_demo.yml
+    with:
+      CONCURRENCY: manual-dispatch-${{ github.run_id}}
+      WHEEL_ARTIFACT_NAME: linux-wheel
+    secrets: inherit
+
+  upload-web-demo:
+    name: 'Upload Web'
+    needs: [build-web-demo]
+    uses: ./.github/workflows/reusable_upload_web_demo.yml
+    with:
+      CONCURRENCY: manual-dispatch-${{ github.run_id}}
+      MARK_PRERELEASE_FOR_MAINLINE: false
+      MARK_TAGGED_VERSION: true
+      RELEASE_VERSION: ${{ github.event.inputs.RELEASE_VERSION }}
+    secrets: inherit
 
   generate-wheel-index:
     name: 'Generate Pip Index'

.github/workflows/manual_dispatch.yml

@@ -36,16 +36,10 @@ on:
         default: 'linux'
 
       BUILD_WEB:
-        description: 'Run reusable_build_web'
-        type: boolean
-        required: false
-        default: true
-
-      BUILD_WEB_DEMO:
-        description: 'Run reusable_build_web'
-        type: boolean
+        description: 'Run reusable_build_web/reusable_build_web_demo (Full build: app,demo)'
+        type: string
         required: false
-        default: true
+        default: 'app,demo'
 
       RELEASE_VERSION:
         description: 'Release Version Number (Must match Cargo.toml)'
@@ -218,7 +212,7 @@ jobs:
 
   build-web:
     name: 'Build Web'
-    if: ${{ github.event.inputs.BUILD_WEB == 'true'}}
+    if: ${{ contains(github.event.inputs.BUILD_WEB, 'app') }}
     uses: ./.github/workflows/reusable_build_web.yml
     with:
       CONCURRENCY: manual-dispatch-${{ github.run_id}}
@@ -228,7 +222,7 @@ jobs:
   upload-web:
     name: 'Upload Web'
     needs: [min-test-wheel, build-web]
-    if: ${{ (github.event.inputs.BUILD_WEB == 'true') && (github.event.inputs.UPLOAD_GCLOUD == 'true') }}
+    if: ${{ contains(github.event.inputs.BUILD_WEB, 'app') && (github.event.inputs.UPLOAD_GCLOUD == 'true') }}
     uses: ./.github/workflows/reusable_upload_web.yml
     with:
       CONCURRENCY: manual-dispatch-${{ github.run_id}}
@@ -240,7 +234,7 @@ jobs:
   build-web-demo:
     name: 'Build Web Demo'
     needs: [min-test-wheel, build-web]
-    if: ${{ github.event.inputs.BUILD_WEB_DEMO == 'true'}}
+    if: ${{ contains(github.event.inputs.BUILD_WEB, 'demo') }}
     uses: ./.github/workflows/reusable_build_web_demo.yml
     with:
       CONCURRENCY: manual-dispatch-${{ github.run_id}}
@@ -250,7 +244,7 @@ jobs:
   upload-web-demo:
     name: 'Upload Web Demo'
     needs: [build-web-demo]
-    if: ${{ (github.event.inputs.BUILD_WEB_DEMO == 'true') && (github.event.inputs.UPLOAD_GCLOUD == 'true') }}
+    if: ${{ contains(github.event.inputs.BUILD_WEB, 'demo') && (github.event.inputs.UPLOAD_GCLOUD == 'true') }}
     uses: ./.github/workflows/reusable_upload_web_demo.yml
     with:
       CONCURRENCY: manual-dispatch-${{ github.run_id}}

.github/workflows/manual_release.yml

@@ -91,4 +91,8 @@ jobs:
           generateReleaseNotes: true
           allowUpdates: true
           draft: true
+
+      - name: Release Web Demo
+        run: |
+          gsutil -m cp -r "gs://rerun-demo/commit/${{ env.SHORT_SHA }}/*" "gs://rerun-demo/version/latest/"
 

.github/workflows/on_pull_request.yml

@@ -81,3 +81,11 @@ jobs:
       CONCURRENCY: pr-${{ github.event.pull_request.number }}
       PR_NUMBER: ${{ github.event.pull_request.number }}
     secrets: inherit
+
+  link-docs:
+    name: 'Link Docs'
+    uses: ./.github/workflows/reusable_pr_link_docs.yml
+    with:
+      CONCURRENCY: pr-${{ github.event.pull_request.number }}
+      PR_NUMBER: ${{ github.event.pull_request.number }}
+    secrets: inherit

.github/workflows/on_push_main.yml

@@ -60,7 +60,7 @@ jobs:
     secrets: inherit
 
   upload-web-demo:
-    name: 'Upload Web'
+    name: 'Upload Web Demo'
     needs: [build-web-demo]
     uses: ./.github/workflows/reusable_upload_web_demo.yml
     with:

.github/workflows/reusable_build_and_test_wheels.yml

@@ -170,10 +170,10 @@ jobs:
         run: ./scripts/setup_web.sh
 
       # The first steps of setup_web.sh, for Windows:
-      - name: Install wasm32 and wasm-bindgen-cli for building the web-viewer Wasm on windows
+      - name: Install wasm32 cargo target for building the web-viewer Wasm on windows
         if: inputs.platform == 'windows'
         shell: bash
-        run: rustup target add wasm32-unknown-unknown && cargo install wasm-bindgen-cli --version 0.2.86
+        run: rustup target add wasm32-unknown-unknown
 
       # The last step of setup_web.sh, for Windows.
       # Since 'winget' is not available within the GitHub runner, we download the package directly:
@@ -243,7 +243,7 @@ jobs:
         # TODO(jleibs): understand why deps can't be installed in the same step as the wheel
         shell: bash
         run: |
-          pip install deprecated numpy>=1.23 pyarrow==10.0.1 pytest==7.1.2
+          pip install deprecated numpy>=1.23 pillow>=9.5.0 pyarrow==10.0.1 pytest==7.1.2
 
       - name: Install built wheel
         if: needs.set-config.outputs.RUN_TESTS == 'true'
@@ -278,18 +278,18 @@ jobs:
         id: dataset
         uses: actions/cache@v3
         with:
-          path: examples/python/colmap/dataset/
+          path: examples/python/structure_from_motion/dataset/
           # TODO(jleibs): Derive this key from the invocation below
-          key: colmap-dataset-colmap-fiat-v0
+          key: structure-from-motion-dataset-structure-from-motion-fiat-v1
 
       - name: Generate Embedded RRD file
         if: needs.set-config.outputs.RUN_TESTS == 'true'
         shell: bash
         # If you change the line below you should almost definitely change the `key:` line above by giving it a new, unique name
         run: |
           mkdir rrd
-          pip install -r examples/python/colmap/requirements.txt
-          python3 examples/python/colmap/main.py --dataset colmap_fiat --resize 800x600 --save rrd/colmap_fiat.rrd
+          pip install -r examples/python/structure_from_motion/requirements.txt
+          python3 examples/python/structure_from_motion/main.py --dataset colmap_fiat --resize 800x600 --save rrd/colmap_fiat.rrd
 
       # All platforms are currently creating the same rrd file, upload one of them
       - name: Save RRD artifact

.github/workflows/reusable_pr_link_docs.yml

@@ -0,0 +1,49 @@
+name: Reusable PR Link Docs
+
+on:
+  workflow_call:
+    inputs:
+      CONCURRENCY:
+        required: true
+        type: string
+      PR_NUMBER:
+        required: true
+        type: string
+
+concurrency:
+  group: ${{ inputs.CONCURRENCY }}-pr-summary
+  cancel-in-progress: true
+
+jobs:
+  pr-link-docs:
+    name: Link to docs preview in PR
+
+    permissions:
+      contents: "read"
+      id-token: "write"
+      pull-requests: "write"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+
+      - name: Install deps
+        run: pip install PyGithub # NOLINT
+
+      - name: Link to docs
+        run: |
+          python scripts/pr_link_docs.py \
+          --github-token ${{ secrets.GITHUB_TOKEN }} \
+          --github-repository ${GITHUB_REPOSITORY} \
+          --pr-number ${{ inputs.PR_NUMBER }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ inputs.PR_NUMBER }}
+

.github/workflows/reusable_upload_web.yml

@@ -32,6 +32,10 @@ on:
         required: false
         type: string
         default: ''
+      UPLOAD_COMMIT:
+        required: false
+        type: boolean
+        default: true
 
 concurrency:
   group: ${{ inputs.CONCURRENCY }}-upload-web
@@ -80,13 +84,15 @@ jobs:
           echo "SHORT_SHA=$(echo $USED_SHA | cut -c1-7)" >> $GITHUB_ENV
 
       - name: "Upload web-viewer (commit)"
+        if: ${{ inputs.UPLOAD_COMMIT }}
         uses: google-github-actions/upload-cloud-storage@v1
         with:
           path: "web_viewer"
           destination: "rerun-web-viewer/commit/${{env.SHORT_SHA}}"
           parent: false
 
       - name: "Upload RRD (commit)"
+        if: ${{ inputs.UPLOAD_COMMIT }}
         uses: google-github-actions/upload-cloud-storage@v1
         with:
           path: "rrd"

.github/workflows/reusable_upload_web_demo.yml

@@ -28,6 +28,10 @@ on:
         required: false
         type: string
         default: ''
+      UPLOAD_COMMIT:
+        required: false
+        type: boolean
+        default: true
 
 concurrency:
   group: ${{ inputs.CONCURRENCY }}-upload-web-demo
@@ -69,6 +73,7 @@ jobs:
           echo "SHORT_SHA=$(echo $USED_SHA | cut -c1-7)" >> $GITHUB_ENV
 
       - name: "Upload web demo (commit)"
+        if: ${{ inputs.UPLOAD_COMMIT }}
         uses: google-github-actions/upload-cloud-storage@v1
         with:
           path: "web_demo"
@@ -90,14 +95,6 @@ jobs:
           path: "web_demo"
           destination: "rerun-demo/version/${{inputs.RELEASE_VERSION}}"
           parent: false
-
-      - name: "Upload web demo (latest)"
-        if: inputs.MARK_TAGGED_VERSION
-        uses: google-github-actions/upload-cloud-storage@v1
-        with:
-          path: "web_demo"
-          destination: "rerun-demo/version/latest"
-          parent: false
 
       - name: "Upload web demo (adhoc)"
         if: ${{ inputs.ADHOC_NAME != '' }}

.mypy.ini

@@ -1,6 +1,6 @@
 [mypy]
 files = rerun_py/rerun_sdk/rerun, rerun_py/tests, examples/python
-exclude = examples/python/objectron/proto|examples/python/ros
+exclude = examples/python/objectron/proto|examples/python/ros_node
 namespace_packages = True
 show_error_codes = True
 strict = True