From cdd021e76d66452e4fcf3af10a2d397d38dc5b3d Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sat, 5 Jul 2025 18:33:02 +0000 Subject: [PATCH] Docs: Update DEVELOPMENT.MD with explicit turbo run commands Updated DEVELOPMENT.MD to use `turbo run ` instead of `turbo ` for clarity and consistency when referring to Turborepo tasks that don't have a direct pnpm script alias. Also, added `dependsOn: ["build"]` to `dist-*` tasks in `turbo.json` to ensure correct build order before packaging. --- DEVELOPMENT.md | 8 ++++---- turbo.json | 18 ++++++++++++------ 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 5ddd0f382..749b2db0e 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -45,7 +45,7 @@ Generally we have 2 types of tests. Unit tests are contained in mostly all the apps and packages (client, server and utils) -You can run unit tests by running turbo `turbo test:pipeline` from the project root. +You can run unit tests by running `turbo run test:pipeline` from the project root. This will run all tests and close test runner. Alternatively you can navigate to an app or project and run `pnpm test` to run those tests in watch mode @@ -76,13 +76,13 @@ You can generate a distribution for your OS by running the following steps. From the project root, run the following commands - __Install the project dependencies__ by running `pnpm i` -- __Build the UI and server__ by running `turbo build:electron` -- __Create the package__ by running `turbo dist-win`, `turbo dist-mac` or `turbo dist-linux` +- __Build the UI and server__ by running `turbo run build:electron` +- __Create the package__ by running `turbo run dist-win`, `turbo run dist-mac` or `turbo run dist-linux` The build distribution assets will be at `.apps/electron/dist` Note: The MacOS build will only work in CI, locally it will fail due to notarisation issues. -Use the `turbo dist-mac:local` command to build a MacOS distribution locally. +Use the `turbo run dist-mac:local` command to build a MacOS distribution locally. ## DOCKER diff --git a/turbo.json b/turbo.json index fae60e834..70c70ff10 100644 --- a/turbo.json +++ b/turbo.json @@ -1,6 +1,6 @@ { "$schema": "https://turbo.build/schema.json", - "globalEnv": ["NODE_ENV", "GITHUB_TOKEN"], + "globalEnv": ["NODE_ENV", "GITHUB_TOKEN", "APPLEID", "APPLEIDPASS", "TEAMID", "CSC_KEY_PASSWORD", "CSC_LINK"], "tasks": { "dev": { "cache": false, @@ -34,12 +34,18 @@ "^build" ] }, - "dist-win": {}, - "dist-mac": { - "env": ["APPLEID", "APPLEIDPASS", "TEAMID", "CSC_KEY_PASSWORD", "CSC_LINK"] + "dist-win": { + "dependsOn": ["build"] + }, + "dist-mac": { + "dependsOn": ["build"] + }, + "dist-mac:local": { + "dependsOn": ["build"] + }, + "dist-linux": { + "dependsOn": ["build"] }, - "dist-mac:local": {}, - "dist-linux": {}, "cleanup": {} } }