Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add outputs to all examples #3830

Merged
merged 8 commits into from
Feb 16, 2023
Merged

Add outputs to all examples #3830

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3a2f344
Outputs are your friend.
anthonyshew Feb 16, 2023
8e7e2f6
Merge branch 'main' of https://github.com/vercel/turbo into outputs-f…
anthonyshew Feb 16, 2023
99c66b6
Fixes
anthonyshew Feb 16, 2023
1495619
A couple more.
anthonyshew Feb 16, 2023
e766806
Update docs/pages/repo/docs/reference/configuration.mdx
anthonyshew Feb 16, 2023
c4f61e0
Update docs/pages/repo/docs/reference/configuration.mdx
anthonyshew Feb 16, 2023
cb6b9b1
Update docs/pages/repo/docs/reference/configuration.mdx
anthonyshew Feb 16, 2023
3c70eda
Merge branch 'main' into outputs-for-code-samples
anthonyshew Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pages/repo/docs/ci/circleci.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ And a `turbo.json`:
"$schema": "https://turbo.build/schema.json",
"pipeline": {
"build": {
"outputs": [".next/**", ".svelte-kit/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
},
"test": {
Expand Down
1 change: 1 addition & 0 deletions docs/pages/repo/docs/ci/github-actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ And a `turbo.json`:
"$schema": "https://turbo.build/schema.json",
"pipeline": {
"build": {
"outputs": [".next/**", ".svelte-kit/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
},
"test": {
Expand Down
1 change: 1 addition & 0 deletions docs/pages/repo/docs/ci/gitlabci.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ And a `turbo.json`:
"$schema": "https://turbo.build/schema.json",
"pipeline": {
"build": {
"outputs": [".next/**", ".svelte-kit/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
},
"test": {
Expand Down
1 change: 1 addition & 0 deletions docs/pages/repo/docs/ci/travisci.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ And a `turbo.json`:
"$schema": "https://turbo.build/schema.json",
"pipeline": {
"build": {
"outputs": [".next/**", ".svelte-kit/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
},
"test": {
Expand Down
1 change: 1 addition & 0 deletions docs/pages/repo/docs/core-concepts/caching.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,7 @@ For example, consider a monorepo with three workspaces: a Next.js project, a Cre
{
"pipeline": {
"build": {
"outputs": [".next/**", "dist/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
}
}
Expand Down
18 changes: 13 additions & 5 deletions docs/pages/repo/docs/core-concepts/monorepos/running-tasks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ First, we declare our tasks inside `turbo.json`:
"build": {
// ^build means build must be run in dependencies
// before it can be run in this workspace
"outputs": [".svelte/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
},
"test": {},
Expand Down Expand Up @@ -83,7 +84,8 @@ The `pipeline` configuration declares which tasks depend on each other in your m
// topological dependencies' and devDependencies'
// `build` tasks being completed first. The `^` symbol
// indicates an upstream dependency.
"dependsOn": ["^build"]
"dependsOn": ["^build"],
"outputs": [".next/**", ".svelte-kit/**"]
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
},
"test": {
// A workspace's `test` task depends on that workspace's
Expand Down Expand Up @@ -120,7 +122,10 @@ If both tasks are in the same workspace, you can specify the relationship like t
{
"$schema": "https://turbo.build/schema.json",
"pipeline": {
"build": {},
"build": {
"dependsOn": ["^build"],
"outputs": [".next/**", ".svelte-kit/**"]
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
},
"deploy": {
// A workspace's `deploy` task depends on the `build`,
// task of the same workspace being completed.
Expand All @@ -145,7 +150,8 @@ The `^` symbol explicitly declares that the task has a dependency on a task in a
"build": {
// "A workspace's `build` command depends on its dependencies'
// and devDependencies' `build` commands being completed first"
"dependsOn": ["^build"]
"dependsOn": ["^build"],
"outputs": [".next/**", ".svelte-kit/**"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"outputs": [".next/**", ".svelte-kit/**"]
"outputs": [".next/**", "!.next/cache/**", ".svelte-kit/**"]

}
}
}
Expand Down Expand Up @@ -179,7 +185,8 @@ The example below describes the `deploy` script of a `frontend` application that
"pipeline": {
// Standard configuration
"build": {
"dependsOn": ["^build"]
"dependsOn": ["^build"],
"outputs": [".next/**", ".svelte-kit/**"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"outputs": [".next/**", ".svelte-kit/**"]
"outputs": [".next/**", "!.next/cache/**", ".svelte-kit/**"]

},
"test": {
"dependsOn": ["^build"]
Expand Down Expand Up @@ -224,7 +231,8 @@ A sample pipeline that defines the root task `format` and opts the root into `te
"$schema": "https://turbo.build/schema.json",
"pipeline": {
"build": {
"dependsOn": ["^build"]
"dependsOn": ["^build"],
"outputs": [".next/**", ".svelte-kit/**"]
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
},
"test": {
"dependsOn": ["^build"],
Expand Down
5 changes: 4 additions & 1 deletion docs/pages/repo/docs/reference/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Items in `dependsOn` without `^` prefix, express the relationships between tasks
"build": {
// "A workspace's `build` command depends on its dependencies'
// or devDependencies' `build` command being completed first"
"outputs": ["dist/**", ".next/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
},
"test": {
Expand Down Expand Up @@ -230,6 +231,7 @@ Defaults to `true`. Whether or not to cache the task [`outputs`](#outputs). Sett
"$schema": "https://turbo.build/schema.json",
"pipeline": {
"build": {
"outputs": ["dist/**", ".svelte-kit/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"dependsOn": ["^build"]
},
"test": {
Expand Down Expand Up @@ -269,7 +271,7 @@ Specifying `[]` will cause the task to be rerun when any file in the workspace c
// A workspace's `test` task depends on that workspace's
// own `build` task being completed first.
"dependsOn": ["build"],
"outputs": [""],
"outputs": ["dist/**", ".next/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
// A workspace's `test` task should only be rerun when
// either a `.tsx` or `.ts` file has changed.
"inputs": ["src/**/*.tsx", "src/**/*.ts", "test/**/*.ts"]
Expand Down Expand Up @@ -299,6 +301,7 @@ Set type of output logging.
"pipeline": {
"build": {
"dependsOn": ["^build"],
"outputs": ["dist/**", ".svelte-kit/**"],
anthonyshew marked this conversation as resolved.
Show resolved Hide resolved
"outputMode": "new-only"
},
"test": {
Expand Down