Merge pull request #30 from mbsantiago/refactor/improve_build

Refactor/improve build

Author: mbsantiago

.github/workflows/build_user_guide.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up uv
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python 3.12
         run: uv python install 3.12
 
       - name: Restore uv cache

.github/workflows/bundle.yml

@@ -3,6 +3,7 @@ name: Bundle App
 on:
   release:
     types: [published]
+  workflow_dispatch:
 
 jobs:
   build-user-guide:
@@ -22,19 +23,26 @@ jobs:
         python-version:
           - "3.12"
         os:
-          - ubuntu-latest
+          - ubuntu-20.04
           - windows-latest
-          - macos-11
+          - macos-12
 
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Setup python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
+      - name: Set up uv
+        if: ${{ matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' }}
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Set up uv
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: irm https://astral.sh/uv/install.ps1 | iex
+        shell: powershell
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
 
       - name: Retrieve built frontend
         uses: actions/download-artifact@v4
@@ -56,21 +64,22 @@ jobs:
           mkdir dist/
           mv "back/dist/whombat.zip" "dist/whombat-${{ matrix.os }}-${{ github.ref_name }}.zip"
 
-      - name: Bundle app (Linux)
-        if: ${{ matrix.os == 'linux-latest' }}
+      - name: Bundle app (Linux/macOS)
+        if: ${{ matrix.os == 'ubuntu-20.04' || matrix.os == "macos-12" }}
         run: |
           bash scripts/bundle_linux.sh
-          mkdir dist/
-          mv back/dist/whombat.zip "dist/whombat-${{ matrix.os }}-${{ github.ref_name }}.zip"
+          mv dist/whombat.zip "dist/whombat-${{ matrix.os }}-${{ github.ref_name }}.zip"
 
-      - name: Bundle app (macOS)
-        if: ${{ matrix.os == 'macos-11' }}
-        run: |
-          bash scripts/bundle_macos.sh
-          mkdir dist/
-          mv back/dist/whombat.zip "dist/whombat-${{ matrix.os }}-${{ github.ref_name }}.zip"
+      # Only run if triggered by user
+      - uses: actions/upload-artifact@v4
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        with:
+          name: "${{ matrix.os }}-${{ github.ref_name }}" # Include ref_name for better organization
+          path: "dist/whombat-${{ matrix.os }}-${{ github.ref_name }}.zip"
 
+      # Only run if release
       - name: Upload release
+        if: ${{ github.event_name == 'release' }}
         uses: shogo82148/actions-upload-release-asset@v1
         with:
           upload_url: ${{ github.event.release.upload_url }}

.github/workflows/docs.yml

@@ -25,7 +25,8 @@ jobs:
       - name: Set up Python
         run: uv python install 3.12
 
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - name: Create cache key
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
 
       - name: Restore mkdocs cache
         uses: actions/cache@v3
@@ -47,7 +48,7 @@ jobs:
       - name: Install the project dependencies
         run: |
           cd back
-          uv sync --all-extras --dev
+          uv sync --dev
 
       - name: Build and Deploy Docs
         run: |

.gitignore

@@ -7,3 +7,5 @@ front/tests-examples
 front/playwright-report
 front/test-results
 .backups
+build/whombat
+dist

Makefile

@@ -1,13 +1,21 @@
 SHELL := /bin/bash
 
+FRONT_DIR := front
+BACK_DIR := back
+
+.PHONY: dev-front dev-back dev-docs storybook install-dev build-frontend build-guide bundle publish clean
+
 dev-front:
-	cd front && npm run dev
+	cd $(FRONT_DIR) && npm run dev
+
+storybook:
+	cd $(FRONT_DIR) && npm run storybook
 
 dev-back:
-	cd back && make serve-dev
+	cd $(BACK_DIR) && make serve-dev
 
 dev-docs:
-	cd back && make serve-docs
+	cd $(BACK_DIR) && make serve-docs
 
 install-dev:
 	bash scripts/install_dev.sh
@@ -18,11 +26,11 @@ build-frontend:
 build-guide:
 	bash scripts/update_guide.sh
 
-bundle-pyinstaller:
+bundle:
 	bash scripts/bundle_linux.sh
 
 publish:
 	bash scripts/publish_pypi.sh
 
-storybook:
-	cd front && npm run storybook
+clean:
+	rm -rf dist/ build/

assets/splash.png

@@ -1,5 +1,6 @@
 "use client";
 
+import dynamic from "next/dynamic";
 import { useState } from "react";
 
 import Pagination from "@/app/components/Pagination";
@@ -12,7 +13,6 @@ import Error from "@/app/error";
 
 import ExplorationLayout from "@/lib/components/layouts/Exploration";
 import ListCounts from "@/lib/components/lists/ListCounts";
-import SoundEventAnnotationsScatterPlot from "@/lib/components/sound_event_annotations/SoundEventAnnotationsScatterPlot";
 import Empty from "@/lib/components/ui/Empty";
 import Loading from "@/lib/components/ui/Loading";
 
@@ -21,6 +21,14 @@ import usePagedQuery from "@/lib/hooks/utils/usePagedQuery";
 
 import type { ScatterPlotData, SoundEventAnnotationFilter } from "@/lib/types";
 
+const SoundEventAnnotationsScatterPlot = dynamic(
+  () =>
+    import(
+      "@/lib/components/sound_event_annotations/SoundEventAnnotationsScatterPlot"
+    ),
+  { ssr: false },
+);
+
 export default function Page() {
   const [selectedSoundEvent, setSelectedSoundEvent] =
     useState<ScatterPlotData | null>(null);

back/uv.lock

@@ -1,10 +1,11 @@
 import { zodResolver } from "@hookform/resolvers/zod";
 import { useCallback } from "react";
 import { useForm } from "react-hook-form";
-import { z } from "zod";
 
 import { UploadIcon } from "@/lib/components/icons";
-import { Input, Group, Submit } from "@/lib/components/inputs/index";
+import { Group, Input, Submit } from "@/lib/components/inputs/index";
+import { AnnotationProjectImportSchema } from "@/lib/schemas";
+import type { AnnotationProjectImport } from "@/lib/types";
 
 export default function AnnotationProjectImport({
   onImportAnnotationProject,
@@ -33,7 +34,7 @@ export default function AnnotationProjectImport({
         name="annotation_project"
         label="Select a project file to import"
         help="The file must be in AOEF format"
-        error={errors.annotation_project?.message}
+        error={errors.annotation_project?.message?.toString()}
       >
         <Input type="file" {...register("annotation_project")} required />
       </Group>
@@ -44,11 +45,3 @@ export default function AnnotationProjectImport({
     </form>
   );
 }
-
-export const AnnotationProjectImportSchema = z.object({
-  annotation_project: z.instanceof(FileList),
-});
-
-export type AnnotationProjectImport = z.infer<
-  typeof AnnotationProjectImportSchema
->;