From 163244b05d956b98cc0a1733c65712764d00807a Mon Sep 17 00:00:00 2001 From: Douglas Parsons Date: Thu, 9 Dec 2021 17:13:32 +0000 Subject: [PATCH 1/2] Add a codeblock explaining how to run a pipeline --- docs/pages/docs/features/pipelines.mdx | 6 ++++++ docs/pages/docs/upgrading-to-v1.mdx | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/pages/docs/features/pipelines.mdx b/docs/pages/docs/features/pipelines.mdx index 7d4ca27daf5a0..e261430c95cbe 100644 --- a/docs/pages/docs/features/pipelines.mdx +++ b/docs/pages/docs/features/pipelines.mdx @@ -53,6 +53,12 @@ The running order based on the `dependsOn` key above is: 3. `lint` 4. `deploy` +The full pipeline can then be run: + +```bash +npx turbo run build test lint deploy +``` + ## Task Dependency Format What you are declaring here in the `pipeline` object of the `turbo` configuration is a dependency graph of tasks. In the above example, in plain english, the configuration translates to the following conventions: diff --git a/docs/pages/docs/upgrading-to-v1.mdx b/docs/pages/docs/upgrading-to-v1.mdx index 23c39c5ca34c4..8a41be167e371 100644 --- a/docs/pages/docs/upgrading-to-v1.mdx +++ b/docs/pages/docs/upgrading-to-v1.mdx @@ -40,7 +40,7 @@ yarn add turbo -W --dev As mentioned, Turborepo now provides zero-config Remote Caching through [Vercel](https://vercel.com?utm_source=turborepo.org&utm_medium=referral&utm_campaign=docs-link). Remote Caching is free for all Vercel plans during this transition period. Each Vercel account has a shared Remote Cache. This cache is shared across all enviroments (Development, Preview, and Production). -**Important**: turborepo.com allowed multiple caches (i.e. projects) per team (denoted through `--project` flag). With v1.x caching on Vercel, each Vercel account (user or team) has a single shared Remote Cache. If you were actively using multiple turbprepo.com projects for your team, please let us know in [Discord](https://turborepo.org/discord). +**Important**: turborepo.com allowed multiple caches (i.e. projects) per team (denoted through `--project` flag). With v1.x caching on Vercel, each Vercel account (user or team) has a single shared Remote Cache. If you were actively using multiple turborepo.com projects for your team, please let us know in [Discord](https://turborepo.org/discord). Please note that we are not migrating cache artifacts to Vercel. We apologize for the slower builds during your migration as you rehydrate your remote cache on Vercel or custom cache infra. From 0933beec4fdeaaa7c7bb41d32be4c5c5df9d9c8c Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Thu, 9 Dec 2021 09:29:17 -0800 Subject: [PATCH 2/2] Update pipelines.mdx --- docs/pages/docs/features/pipelines.mdx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/pages/docs/features/pipelines.mdx b/docs/pages/docs/features/pipelines.mdx index e261430c95cbe..c4a0b917ba708 100644 --- a/docs/pages/docs/features/pipelines.mdx +++ b/docs/pages/docs/features/pipelines.mdx @@ -46,12 +46,12 @@ An example Pipeline configuration: } ``` -The running order based on the `dependsOn` key above is: +The rough execution order for a given package based on the `dependsOn` keys above will be: -1. `build` -2. `test` -3. `lint` -4. `deploy` +1. `build` once its depdendencies have run their `build` commands +2. `test` once its _own_ `build` command is finished +3. `lint` whenever +4. `deploy` once its _own_ `build`, `test`, and `lint` commands have finished The full pipeline can then be run: @@ -59,6 +59,8 @@ The full pipeline can then be run: npx turbo run build test lint deploy ``` +Turborepo will then efficiently schedule exection minimizing idle CPUs. + ## Task Dependency Format What you are declaring here in the `pipeline` object of the `turbo` configuration is a dependency graph of tasks. In the above example, in plain english, the configuration translates to the following conventions: