Skip to content

Commit 8142a11

Browse files
authored
docs: deploy build path flags and config file auto-detection (#4858)
Refreshes deployment-related docs.
1 parent 43ecf15 commit 8142a11

3 files changed

Lines changed: 26 additions & 2 deletions

File tree

docs/github-integration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This eliminates the need to manually run the `trigger.dev deploy` command or set
3434
<Step title="Customize build settings (optional)">
3535
Configure how your project is built:
3636

37-
- **Trigger config file**: Path to your `trigger.config.ts` file. By default, we look for it in the root of your repository. The path should be relative to the root of your repository and contain the config file name, e.g., `apps/tasks/trigger.config.ts`.
37+
- **Trigger config file**: Auto-detected by default — we find your `trigger.config.ts` anywhere in your repository. Set a path relative to the root of your repository to override it, e.g., `apps/tasks/trigger.config.ts`. If your repository contains more than one config file, set the path of the one to use.
3838
- **Install command**: Auto-detected by default, but you can override it if necessary. The command will be run from the root of your repository.
3939
- **Pre-build command**: Run any commands before building and deploying your project, e.g., `pnpm run prisma:generate`. The command will be run from the root of your repository.
4040
</Step>

docs/snippets/cli-commands-deploy.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,34 @@ npx trigger.dev@latest deploy [path]
9898
briefly before it notices. Requires `--external-id`.
9999
</ParamField>
100100

101+
<ParamField body="Native build" type="--native-build">
102+
Use the native build server to install, bundle and build your project.
103+
</ParamField>
104+
105+
<ParamField body="Local bundle" type="--local-bundle">
106+
Install and bundle on your machine, then build the image on the build server from the uploaded
107+
bundle. Requires `--native-build`. Use it if you prefer dependencies to be installed on your
108+
machine rather than on the build server.
109+
</ParamField>
110+
111+
<ParamField body="Detach" type="--detach">
112+
Exit once the build is queued instead of streaming the build logs. The deployment continues on
113+
the build server. Requires `--native-build`.
114+
</ParamField>
115+
116+
<ParamField body="Depot build" type="--depot-build">
117+
Build the image with Depot, the default build provider.
118+
</ParamField>
119+
101120
<ParamField body="Local build" type="--local-build">
102121
Force building the deployment image locally using your local Docker. This is automatic when self-hosting.
103122
</ParamField>
104123

124+
<ParamField body="Build logs" type="--build-logs">
125+
How build logs are shown: `compact` (default, a single updating line) or `full` (every log line).
126+
CI and piped output always use `full`.
127+
</ParamField>
128+
105129
### Common options
106130

107131
These options are available on most commands.

docs/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Usually there will be some useful guidance below this message. If you can't figu
8787

8888
### `resource_exhausted`
8989

90-
If you see a `resource_exhausted` error during deploy, the build may have hit resource limits on our build infrastructure. Try our [native builder](https://trigger.dev/changelog/deployments-with-native-builds).
90+
If you see a `resource_exhausted` error during deploy, the build may have hit resource limits on our build infrastructure. Try our [native builder](https://trigger.dev/changelog/deployments-with-native-builds) by deploying with the `--native-build` flag.
9191

9292
### `No loader is configured for ".node" files`
9393

0 commit comments

Comments
 (0)