v0.4.0 release

.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  server-ci:
+    name: Server CI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        id: install_python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.8.4"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        working-directory: ./python
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
+
+      - name: Install dependencies (used by later workflows)
+        working-directory: ./python
+        run: |
+          poetry install
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      - name: Saved cached virtualenv
+        uses: actions/cache/save@v4
+        with:
+          path: ./python/.venv
+          key: venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
+
+      - name: Lint with ruff
+        working-directory: ./python
+        run: ruff check --output-format=github
+
+      # - name: Typecheck with pyright
+      #   working-directory: ./python
+      #   run: pyright arflow
+      #
+      # - name: Test with pytest
+      #   working-directory: ./python
+      #   timeout-minutes: 5 # pytest sometimes hangs for (yet) unknown reasons
+      #   run: |
+      #     pytest

.github/workflows/pre-release.yml

@@ -0,0 +1,71 @@
+name: Pre-release
+
+on:
+  push:
+    tags:
+      - "*"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Release package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        id: install_python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.8.4"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        working-directory: ./python
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
+        with:
+          path: ./python/.venv
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
+
+      - name: Install dependencies (skipped if cache hit, fallback to install)
+        working-directory: ./python
+        run: |
+          poetry install
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      - name: Saved cached virtualenv
+        uses: actions/cache/save@v4
+        with:
+          path: ./python/.venv
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
+
+      - name: Configure Test PyPI with Poetry
+        working-directory: ./python
+        run: |
+          poetry config repositories.testpypi https://test.pypi.org/legacy/
+          poetry config pypi-token.testpypi ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      - name: Build and publish the package
+        working-directory: ./python
+        run: poetry publish --build -r testpypi

.github/workflows/publish-docs.yml

@@ -0,0 +1,146 @@
+name: Publish docs
+
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  pages: write
+  id-token: write
+
+jobs:
+  build-protos-docs:
+    name: Build protos docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Buf CLI
+        uses: bufbuild/buf-setup-action@v1.47.2 # must match mise.toml
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+
+      - name: Build protos docs
+        run: buf generate
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: protos-docs
+          path: ./website/docs/protos
+
+  build-client-docs:
+    name: Build client docs
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Dotnet Setup
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.x
+
+      - name: Update docfx
+        run: dotnet tool update -g docfx
+
+      - name: Run script to build the documentation
+        working-directory: ./unity/Documentation
+        run: ./scripts/build.cmd
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: client-docs
+          path: ./website/docs/client
+
+  build-server-docs:
+    name: Build server docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        id: install_python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.8.4"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        working-directory: ./python
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
+        with:
+          path: ./python/.venv
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
+
+      - name: Install docs dependencies
+        working-directory: ./python
+        run: |
+          poetry install --with docs
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      - name: Build the documentation
+        working-directory: ./python
+        run: python tools/make_docs_cli.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: server-docs
+          path: ./website/docs/server
+
+  upload-website:
+    name: Upload website
+    needs: [build-protos-docs, build-client-docs, build-server-docs]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: protos-docs
+          path: ./website/docs/protos
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: client-docs
+          path: ./website/docs/client
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: server-docs
+          path: ./website/docs/server
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./website
+
+  # Single deploy job since we're just deploying
+  deploy-website:
+    name: Deploy website
+    needs: upload-website
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -0,0 +1,82 @@
+name: Release
+
+on:
+  release:
+    types:
+      - published
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Release package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        id: install_python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.8.4"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        working-directory: ./python
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - name: Restore cached virtualenv
+        uses: actions/cache/restore@v4
+        with:
+          path: ./python/.venv
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
+
+      - name: Install dependencies (skipped if cache hit, fallback to install)
+        working-directory: ./python
+        run: |
+          poetry install
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
+
+      - name: Saved cached virtualenv
+        uses: actions/cache/save@v4
+        with:
+          path: ./python/.venv
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
+
+      - name: Use PyPI API token
+        working-directory: ./python
+        run: poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Build and publish the package
+        working-directory: ./python
+        run: poetry publish --build
+
+      - name: Upload Python package to GitHub
+        uses: actions/upload-artifact@v4
+        with:
+          path: ./python/dist/
+          if-no-files-found: error
+
+  publish-docs:
+    name: Publish documentation
+    permissions:
+      pages: write
+      id-token: write
+    uses: ./.github/workflows/publish-docs.yml