High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
chore: migrate mobile makefile to mise (#28390)
Jason Rasmussen58beac8fe0e7
diff --git a/.github/workflows/build-mobile.yml b/.github/workflows/build-mobile.ymlindex 13427cdc24..f3f254e4be 100644--- a/.github/workflows/build-mobile.yml+++ b/.github/workflows/build-mobile.yml@@ -90,6 +90,11 @@ jobs:persist-credentials: falsetoken: ${{ steps.token.outputs.token }}+ - name: Setup Mise+ uses: immich-app/devtools/actions/use-mise@cf6e190bacde3d7bda59372a786b36ac7d01536a # use-mise-action-v2.0.1+ with:+ github_token: ${{ steps.token.outputs.token }}+- name: Create the Keystoreif: ${{ !github.event.pull_request.head.repo.fork }}env:@@ -114,13 +119,6 @@ jobs:mobile/.dart_toolkey: build-mobile-gradle-${{ runner.os }}-main- - name: Setup Flutter SDK- uses: subosito/flutter-action@1a449444c387b1966244ae4d4f8c696479add0b2 # v2.23.0- with:- channel: 'stable'- flutter-version-file: ./mobile/pubspec.yaml- cache: true-- name: Setup Android SDKuses: android-actions/setup-android@40fd30fb8d7440372e1316f5d1809ec01dcd3699 # v4.0.1with:@@ -131,11 +129,10 @@ jobs:run: flutter pub get- name: Generate translation file- run: dart run easy_localization:generate -S ../i18n && dart run bin/generate_keys.dart- working-directory: ./mobile+ run: mise //mobile:codegen:translation- name: Generate platform APIs- run: make pigeon+ run: mise //mobile:codegen:pigeonworking-directory: ./mobile- name: Build Android App Bundle@@ -205,6 +202,12 @@ jobs:runs-on: macos-15steps:+ - id: token+ uses: immich-app/devtools/actions/create-workflow-token@caa599d954228439ea3e8ce1c3328f41ab120ee6 # create-workflow-token-action-v2.0.0+ with:+ client-id: ${{ secrets.PUSH_O_MATIC_APP_CLIENT_ID }}+ private-key: ${{ secrets.PUSH_O_MATIC_APP_KEY }}+- name: Select Xcode 26run: sudo xcode-select -s /Applications/Xcode_26.2.app/Contents/Developer@@ -214,24 +217,20 @@ jobs:ref: ${{ inputs.ref || github.sha }}persist-credentials: false- - name: Setup Flutter SDK- uses: subosito/flutter-action@1a449444c387b1966244ae4d4f8c696479add0b2 # v2.23.0+ - name: Setup Mise+ uses: immich-app/devtools/actions/use-mise@cf6e190bacde3d7bda59372a786b36ac7d01536a # use-mise-action-v2.0.1with:- channel: 'stable'- flutter-version-file: ./mobile/pubspec.yaml- cache: true+ github_token: ${{ steps.token.outputs.token }}- name: Install Flutter dependenciesworking-directory: ./mobilerun: flutter pub get- name: Generate translation files- run: dart run easy_localization:generate -S ../i18n && dart run bin/generate_keys.dart- working-directory: ./mobile+ run: mise //mobile:codegen:translation- name: Generate platform APIs- run: make pigeon- working-directory: ./mobile+ run: mise //mobile:codegen:pigeon- name: Setup Rubyuses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0diff --git a/.github/workflows/static_analysis.yml b/.github/workflows/static_analysis.ymlindex 70a7294424..10642fbd11 100644--- a/.github/workflows/static_analysis.yml+++ b/.github/workflows/static_analysis.yml@@ -60,38 +60,30 @@ jobs:persist-credentials: falsetoken: ${{ steps.token.outputs.token }}- - name: Setup Flutter SDK- uses: subosito/flutter-action@1a449444c387b1966244ae4d4f8c696479add0b2 # v2.23.0+ - name: Setup Mise+ uses: immich-app/devtools/actions/use-mise@cf6e190bacde3d7bda59372a786b36ac7d01536a # use-mise-action-v2.0.1with:- channel: 'stable'- flutter-version-file: ./mobile/pubspec.yaml+ github_token: ${{ steps.token.outputs.token }}- name: Install dependencies- run: dart pub get+ run: flutter pub get- name: Install dependencies for UI package- run: dart pub get+ run: flutter pub getworking-directory: ./mobile/packages/ui- name: Install dependencies for UI Showcase- run: dart pub get+ run: flutter pub getworking-directory: ./mobile/packages/ui/showcase- - name: Install DCM- uses: CQLabs/setup-dcm@8697ae0790c0852e964a6ef1d768d62a6675481a # v2.0.1- with:- github-token: ${{ steps.token.outputs.token }}- version: auto- working-directory: ./mobile-- - name: Generate translation file- run: dart run easy_localization:generate -S ../i18n && dart run bin/generate_keys.dart+ - name: Generate translation files+ run: mise //mobile:codegen:translation- name: Run Build Runner- run: make build+ run: mise //mobile:codegen:dart- name: Generate platform API- run: make pigeon+ run: mise //mobile:codegen:pigeon- name: Find file changesuses: tj-actions/verify-changed-files@a1c6acee9df209257a246f2cc6ae8cb6581c1edf # v20.0.4@@ -107,20 +99,16 @@ jobs:env:CHANGED_FILES: ${{ steps.verify-changed-files.outputs.changed_files }}run: |- echo "ERROR: Generated files not up to date! Run 'make build' and 'make pigeon' inside the mobile directory"+ echo "ERROR: Generated files not up to date! Run 'mise //mobile:codegen:dart' and 'mise //mobile:codegen:pigeon'"echo "Changed files: ${CHANGED_FILES}"exit 1- - name: Run dart analyze- run: dart analyze --fatal-infos+ - name: Run analyze+ run: mise //mobile:analyze- - name: Run dart format- run: make format+ - name: Run format+ run: mise //mobile:format# TODO: Re-enable after upgrading custom_lint# - name: Run dart custom_lint# run: dart run custom_lint-- # TODO: Use https://github.com/CQLabs/dcm-action- - name: Run DCM- run: dcm analyze lib --fatal-style --fatal-warningsdiff --git a/.github/workflows/test.yml b/.github/workflows/test.ymlindex 18a88bd617..4656ff2646 100644--- a/.github/workflows/test.yml+++ b/.github/workflows/test.yml@@ -551,17 +551,22 @@ jobs:with:persist-credentials: falsetoken: ${{ steps.token.outputs.token }}- - name: Setup Flutter SDK- uses: subosito/flutter-action@1a449444c387b1966244ae4d4f8c696479add0b2 # v2.23.0++ - name: Setup Mise+ uses: immich-app/devtools/actions/use-mise@cf6e190bacde3d7bda59372a786b36ac7d01536a # use-mise-action-v2.0.1with:- channel: 'stable'- flutter-version-file: ./mobile/pubspec.yaml- - name: Generate translation file- run: dart run easy_localization:generate -S ../i18n && dart run bin/generate_keys.dart+ github_token: ${{ steps.token.outputs.token }}++ - name: Install dependencies+ run: flutter pub getworking-directory: ./mobile++ - name: Generate translation files+ run: mise //mobile:codegen:translation+- name: Run tests- working-directory: ./mobile- run: flutter test -j 1+ run: mise //mobile:test -j 1+ml-unit-tests:name: Unit Test MLneeds: pre-jobdiff --git a/docs/docs/developer/pr-checklist.md b/docs/docs/developer/pr-checklist.mdindex e5dc6cc1e5..c4ed44c77b 100644--- a/docs/docs/developer/pr-checklist.md+++ b/docs/docs/developer/pr-checklist.md@@ -34,21 +34,23 @@ Run all web checks with `pnpm run check:all`Run all server checks with `pnpm run check:all`:::-:::info Auto Fix+:::tip Auto FixYou can use `pnpm run __:fix` to potentially correct some issues automatically for `pnpm run format` and `lint`.:::-## Mobile Checks+## Mobile Checklist-The following commands must be executed from within the mobile app directory of the codebase.+- [ ] `mise //mobile:codegen` (auto-generate files using build_runner)+- [ ] `mise //mobile:lint` (static analysis via Dart Analyzer and DCM)+- [ ] `mise //mobile:format` (formatting via Dart Formatter)+- [ ] `mise //mobile:test` (unit tests)-- [ ] `make build` (auto-generate files using build_runner)-- [ ] `make analyze` (static analysis via Dart Analyzer and DCM)-- [ ] `make format` (formatting via Dart Formatter)-- [ ] `make test` (unit tests)+:::tip+Run all these commands at once with `mise //mobile:checklist`+:::-:::info Auto Fix-You can use `dart fix --apply` and `dcm fix lib` to potentially correct some issues automatically for `make analyze`.+:::tip Auto Fix+You can use `mise //mobile:lint-fix` to potentially correct some issues automatically for `mise //mobile:lint`.:::## OpenAPIdiff --git a/docs/docs/developer/testing.md b/docs/docs/developer/testing.mdindex d7c9edcd31..219c33d1a1 100644--- a/docs/docs/developer/testing.md+++ b/docs/docs/developer/testing.md@@ -17,15 +17,14 @@ make e2eBefore you can run the tests, you need to run the following commands _once_:-- `pnpm install` (in `e2e/`)-- `pnpm run build` (in `cli/`)-- `make open-api` (in the project root `/`)+- `pnpm install`+- `pnpm --filter "@immich/*" build`+- `mise //:open-api`Once the test environment is running, the e2e tests can be run via:```bash-cd e2e/-pnpm test+mise //e2e:test```The tests check various things including:diff --git a/mise.toml b/mise.tomlindex a88e3bb2b1..f190490f17 100644--- a/mise.toml+++ b/mise.toml@@ -69,17 +69,15 @@ run = "node ./dist/bin/sync-sql.js"# SDK tasks[tasks."sdk:install"]dir = "packages/sdk"-run = "pnpm install --filter @immich/sdk --frozen-lockfile"+run = "pnpm --filter @immich/sdk install --frozen-lockfile"[tasks."sdk:build"]dir = "packages/sdk"-run = "pnpm run build"+run = "pnpm build"# i18n tasks[tasks."i18n:format"]-dir = "i18n"-run = "pnpm run format"+run = "pnpm format"[tasks."i18n:format-fix"]-dir = "i18n"-run = "pnpm run format:fix"+run = "pnpm format:fix"diff --git a/mobile/makefile b/mobile/makefileindex 3a0a263687..5a21287b85 100644--- a/mobile/makefile+++ b/mobile/makefile@@ -1,55 +1,26 @@-.PHONY: build watch create_app_icon create_splash build_release_android pigeon test analyze format+.PHONY: build watch create_app_icon create_splash build_release_android pigeon test analyze format migration translationbuild:- dart run build_runner build --delete-conflicting-outputs-# Remove once auto_route updated to 10.1.0- dart format lib/routing/router.gr.dart+ @printf "This command has been removed. Please use:\n\n mise codegen # or mise //:mobile:codegen:dart from another directory\n\n" >&2 && exit 1pigeon:- dart run pigeon --input pigeon/native_sync_api.dart- dart run pigeon --input pigeon/local_image_api.dart- dart run pigeon --input pigeon/remote_image_api.dart- dart run pigeon --input pigeon/background_worker_api.dart- dart run pigeon --input pigeon/background_worker_lock_api.dart- dart run pigeon --input pigeon/connectivity_api.dart- dart run pigeon --input pigeon/network_api.dart- dart format lib/platform/native_sync_api.g.dart- dart format lib/platform/local_image_api.g.dart- dart format lib/platform/remote_image_api.g.dart- dart format lib/platform/background_worker_api.g.dart- dart format lib/platform/background_worker_lock_api.g.dart- dart format lib/platform/connectivity_api.g.dart- dart format lib/platform/network_api.g.dart--watch:- dart run build_runner watch --delete-conflicting-outputs--create_app_icon:- flutter pub run flutter_launcher_icons:main--create_splash:- flutter pub run flutter_native_splash:create+ @printf "This command has been removed. Please use:\n\n mise pigeon # or mise //:mobile:codegen:pigeon from another directory\n\n" >&2 && exit 1+build_release_android:- flutter build appbundle+ @printf "This command has been removed. Please use:\n\n mise run build:android # or mise //:mobile:build:android from another directory\n\n" >&2 && exit 1migration:- dart run drift_dev make-migrations+ @printf "This command has been removed. Please use:\n\n mise migration # or mise //:mobile:drift:migration from another directory\n\n" >&2 && exit 1translation:- pnpm --prefix ../i18n run format:fix- dart run easy_localization:generate -S ../i18n- dart run bin/generate_keys.dart- dart format lib/generated/codegen_loader.g.dart- dart format lib/generated/translations.g.dart+ @printf "This command has been removed. Please use:\n\n mise translation # or mise //:mobile:codegen:translation from another directory\n\n" >&2 && exit 1analyze:- dart analyze --fatal-infos- dcm analyze lib --fatal-style --fatal-warnings+ @printf "This command has been removed. Please use:\n\n mise analyze # or mise //:mobile:lint from another directory\n\n" >&2 && exit 1format:-# Ignore generated files manually until https://github.com/dart-lang/dart_style/issues/864 is resolved- dart format --set-exit-if-changed $$(find lib -name '*.dart' -not \( -name 'generated_plugin_registrant.dart' -o -name '*.g.dart' -o -name '*.drift.dart' \))+ @printf "This command has been removed. Please use:\n\n mise format # or mise //:mobile:format from another directory\n\n" >&2 && exit 1test:- flutter test+ @printf "This command has been removed. Please use:\n\n mise test # or mise //:mobile:test from another directory\n\n" >&2 && exit 1diff --git a/mobile/mise.toml b/mobile/mise.tomlindex ed928f2445..89a9f0035c 100644--- a/mobile/mise.toml+++ b/mobile/mise.toml@@ -29,12 +29,15 @@ run = "dart run build_runner watch --delete-conflicting-outputs"[tasks."codegen:pigeon"]alias = "pigeon"description = "Generate pigeon platform code"-depends = [- "pigeon:native-sync",- "pigeon:thumbnail",- "pigeon:background-worker",- "pigeon:background-worker-lock",- "pigeon:connectivity",+run = [+ "dart run pigeon --input pigeon/native_sync_api.dart",+ "dart run pigeon --input pigeon/local_image_api.dart",+ "dart run pigeon --input pigeon/remote_image_api.dart",+ "dart run pigeon --input pigeon/background_worker_api.dart",+ "dart run pigeon --input pigeon/background_worker_lock_api.dart",+ "dart run pigeon --input pigeon/connectivity_api.dart",+ "dart run pigeon --input pigeon/network_api.dart",+ "dart format lib/platform/native_sync_api.g.dart lib/platform/local_image_api.g.dart lib/platform/remote_image_api.g.dart lib/platform/background_worker_api.g.dart lib/platform/background_worker_lock_api.g.dart lib/platform/connectivity_api.g.dart lib/platform/network_api.g.dart",][tasks."codegen:translation"]@@ -60,13 +63,15 @@ run = "flutter pub run flutter_native_splash:create"description = "Run mobile tests"run = "flutter test"-[tasks.lint]+[tasks.analyze]+alias = "lint"description = "Analyze Dart code"depends = ["analyze:dart", "analyze:dcm"]-[tasks."lint-fix"]+[tasks."analyze-fix"]+alias = "lint-fix"description = "Auto-fix Dart code"-depends = ["analyze:fix:dart", "analyze:fix:dcm"]+depends = ["analyze-fix:dart", "analyze-fix:dcm"][tasks.format]description = "Format Dart code"@@ -83,75 +88,6 @@ run = "dart run drift_dev make-migrations"# Internal tasks-[tasks."pigeon:native-sync"]-description = "Generate native sync API pigeon code"-hide = true-sources = ["pigeon/native_sync_api.dart"]-outputs = [- "lib/platform/native_sync_api.g.dart",- "ios/Runner/Sync/Messages.g.swift",- "android/app/src/main/kotlin/app/alextran/immich/sync/Messages.g.kt",-]-run = [- "dart run pigeon --input pigeon/native_sync_api.dart",- "dart format lib/platform/native_sync_api.g.dart",-]--[tasks."pigeon:thumbnail"]-description = "Generate thumbnail API pigeon code"-hide = true-sources = ["pigeon/thumbnail_api.dart"]-outputs = [- "lib/platform/thumbnail_api.g.dart",- "ios/Runner/Images/Thumbnails.g.swift",- "android/app/src/main/kotlin/app/alextran/immich/images/Thumbnails.g.kt",-]-run = [- "dart run pigeon --input pigeon/thumbnail_api.dart",- "dart format lib/platform/thumbnail_api.g.dart",-]--[tasks."pigeon:background-worker"]-description = "Generate background worker API pigeon code"-hide = true-sources = ["pigeon/background_worker_api.dart"]-outputs = [- "lib/platform/background_worker_api.g.dart",- "ios/Runner/Background/BackgroundWorker.g.swift",- "android/app/src/main/kotlin/app/alextran/immich/background/BackgroundWorker.g.kt",-]-run = [- "dart run pigeon --input pigeon/background_worker_api.dart",- "dart format lib/platform/background_worker_api.g.dart",-]--[tasks."pigeon:background-worker-lock"]-description = "Generate background worker lock API pigeon code"-hide = true-sources = ["pigeon/background_worker_lock_api.dart"]-outputs = [- "lib/platform/background_worker_lock_api.g.dart",- "android/app/src/main/kotlin/app/alextran/immich/background/BackgroundWorkerLock.g.kt",-]-run = [- "dart run pigeon --input pigeon/background_worker_lock_api.dart",- "dart format lib/platform/background_worker_lock_api.g.dart",-]--[tasks."pigeon:connectivity"]-description = "Generate connectivity API pigeon code"-hide = true-sources = ["pigeon/connectivity_api.dart"]-outputs = [- "lib/platform/connectivity_api.g.dart",- "ios/Runner/Connectivity/Connectivity.g.swift",- "android/app/src/main/kotlin/app/alextran/immich/connectivity/Connectivity.g.kt",-]-run = [- "dart run pigeon --input pigeon/connectivity_api.dart",- "dart format lib/platform/connectivity_api.g.dart",-]-[tasks."i18n:loader"]description = "Generate i18n loader"hide = true@@ -182,12 +118,23 @@ description = "Run Dart Code Metrics"hide = truerun = "dcm analyze lib --fatal-style --fatal-warnings"-[tasks."analyze:fix:dart"]+[tasks."analyze-fix:dart"]description = "Auto-fix Dart analysis"hide = truerun = "dart fix --apply"-[tasks."analyze:fix:dcm"]+[tasks."analyze-fix:dcm"]description = "Auto-fix Dart Code Metrics"hide = truerun = "dcm fix lib"+++[tasks.checklist]+run = [+ {task = "codegen:pigeon" },+ {task = "codegen:dart" },+ {task = "codegen:translation" },+ {task = "analyze" },+ {task = "format" },+ {task = "test" },+]