dev: Create a Python package, build Docker images from it

.dockerignore

@@ -6,7 +6,7 @@
 .idea
 .vscode
 
-__pycache__/
+**/__pycache__/
 *.py[cod]
 *$py.class
 *.so
@@ -25,9 +25,11 @@ venv
 
 */node_modules
 */dist
+/dist/
 */data/db
 */mealie/test
 */mealie/.temp
+/mealie/frontend/
 
 model.crfmodel
 

.github/workflows/e2e.yml

@@ -3,8 +3,15 @@ on:
   workflow_call:
 
 jobs:
+  build-package:
+    name: "Build Python package"
+    uses: ./.github/workflows/partial-package.yml
+    with:
+      tag: e2e
+
   test:
     timeout-minutes: 60
+    needs: build-package
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -18,11 +25,18 @@ jobs:
         cache-dependency-path: ./tests/e2e/yarn.lock
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v3
+    - name: Retrieve Python package
+      uses: actions/download-artifact@v4
+      with:
+        name: backend-dist
+        path: dist
     - name: Build Image
       uses: docker/build-push-action@v5
       with:
         file: ./docker/Dockerfile
         context: .
+        build-contexts: |
+          packages=dist
         push: false
         load: true
         tags: mealie:e2e

.github/workflows/nightly.yml

@@ -21,7 +21,7 @@ jobs:
     uses: ./.github/workflows/partial-backend.yml
 
   frontend-tests:
-    name: "Frontend and End-to-End Tests"
+    name: "Frontend Tests"
     uses: ./.github/workflows/partial-frontend.yml
 
   build-release:

.github/workflows/partial-backend.yml

@@ -1,4 +1,4 @@
-name: Backend Test/Lint
+name: Backend Lint and Test
 
 on:
   workflow_call:

.github/workflows/partial-builder.yml

@@ -16,7 +16,14 @@ on:
         required: true
 
 jobs:
+  build-package:
+    name: "Build Python package"
+    uses: ./.github/workflows/partial-package.yml
+    with:
+      tag: ${{ inputs.tag }}
+
   publish:
+    needs: build-package
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -35,18 +42,22 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-      - name: Override __init__.py
-        run: |
-          echo "__version__ = \"${{ inputs.tag }}\"" > ./mealie/__init__.py
-
       - uses: depot/setup-action@v1
 
+      - name: Retrieve Python package
+        uses: actions/download-artifact@v4
+        with:
+          name: backend-dist
+          path: dist
+
       - name: Build and push Docker image, via Depot.dev
         uses: depot/build-push-action@v1
         with:
           project: srzjb6mhzm
           file: ./docker/Dockerfile
           context: .
+          build-contexts: |
+            packages=dist
           platforms: linux/amd64,linux/arm64
           push: true
           tags: |

.github/workflows/partial-frontend.yml

@@ -1,4 +1,4 @@
-name: Frontend Build/Lin
+name: Frontend Lint and Test
 
 on:
   workflow_call:
@@ -41,37 +41,3 @@ jobs:
       - name: Run tests 🧪
         run: yarn test:ci
         working-directory: "frontend"
-
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout 🛎
-        uses: actions/checkout@v4
-
-      - name: Setup node env 🏗
-        uses: actions/[email protected]
-        with:
-          node-version: 16
-          check-latest: true
-
-      - name: Get yarn cache directory path 🛠
-        id: yarn-cache-dir-path
-        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
-
-      - name: Cache node_modules 📦
-        uses: actions/cache@v4
-        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-
-      - name: Install dependencies 👨🏻‍💻
-        run: yarn
-        working-directory: "frontend"
-
-      - name: Run Build 🚚
-        run: yarn build
-        working-directory: "frontend"

.github/workflows/partial-package.yml

@@ -0,0 +1,102 @@
+name: Package build
+
+on:
+  workflow_call:
+    inputs:
+      tag:
+        required: true
+        type: string
+
+jobs:
+  build-frontend:
+    name: Build frontend
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+
+      - name: Setup node env 🏗
+        uses: actions/[email protected]
+        with:
+          node-version: 16
+          check-latest: true
+
+      - name: Get yarn cache directory path 🛠
+        id: yarn-cache-dir-path
+        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache node_modules 📦
+        uses: actions/cache@v4
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies 👨🏻‍💻
+        run: yarn
+        working-directory: "frontend"
+
+      - name: Run Build 🚚
+        run: yarn generate
+        working-directory: "frontend"
+
+      - name: Archive built frontend
+        uses: actions/upload-artifact@v4
+        with:
+          name: frontend-dist
+          path: frontend/dist
+          retention-days: 5
+
+  build-package:
+    name: Build Python package
+    needs: build-frontend
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install Task
+        uses: arduino/setup-task@v2
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          plugins: |
+            poetry-plugin-export
+
+      - name: Retrieve built frontend
+        uses: actions/download-artifact@v4
+        with:
+          name: frontend-dist
+          path: mealie/frontend
+
+      - name: Override __init__.py
+        run: |
+          echo "__version__ = \"${{ inputs.tag }}\"" > ./mealie/__init__.py
+
+      - name: Build package and requirements.txt
+        env:
+          SKIP_PACKAGE_DEPS: true
+        run: |
+          task py:package
+
+      - name: Archive built package
+        uses: actions/upload-artifact@v4
+        with:
+          name: backend-dist
+          path: dist
+          retention-days: 5

.github/workflows/pull-requests.yml

@@ -19,7 +19,7 @@ jobs:
     uses: ./.github/workflows/partial-backend.yml
 
   frontend-tests:
-    name: "Frontend and End-to-End Tests"
+    name: "Frontend Tests"
     uses: ./.github/workflows/partial-frontend.yml
 
   container-scanning:

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     uses: ./.github/workflows/partial-backend.yml
 
   frontend-tests:
-    name: "Frontend and End-to-End Tests"
+    name: "Frontend Tests"
     uses: ./.github/workflows/partial-frontend.yml
 
   build-release:

.gitignore

@@ -52,7 +52,7 @@ pnpm-debug.log*
 env/
 build/
 develop-eggs/
-
+/dist/
 downloads/
 eggs/
 .eggs/
@@ -66,6 +66,9 @@ wheels/
 .installed.cfg
 *.egg
 
+# frontend copied into Python module for packaging purposes
+/mealie/frontend/
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.