Skip to content

Commit bba4feb

Browse files
committed
Added preview/branch to the CLI deploy docs
1 parent 76bca03 commit bba4feb

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

docs/snippets/cli-commands-deploy.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import ProjectRefOption from "/snippets/cli-options-project-ref.mdx";
44
import EnvFileOption from "/snippets/cli-options-env-file.mdx";
55
import ConfigFileOption from "/snippets/cli-options-config-file.mdx";
66
import SkipUpdateCheckOption from "/snippets/cli-options-skip-update-check.mdx";
7+
import BranchOption from "/snippets/cli-options-branch.mdx";
78

89
Run the command like this:
910

@@ -56,9 +57,12 @@ npx trigger.dev@latest deploy [path]
5657
<SkipUpdateCheckOption />
5758

5859
<ParamField body="Environment" type="--env | -e">
59-
Defaults to `prod` but you can specify `staging`.
60+
Defaults to `prod` but you can specify `staging` or `preview`. If you specify `preview` we will
61+
try and automatically detect the branch name from git.
6062
</ParamField>
6163

64+
<BranchOption />
65+
6266
<ParamField body="Dry run" type="--dry-run">
6367
Create a deployable build but don't deploy it. Prints out the build path so you can inspect it.
6468
</ParamField>

docs/snippets/cli-options-branch.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<ParamField body="Preview branch" type="--branch | -b">
2+
When using `--env preview` the branch is automatically detected from git. But you can manually
3+
specify it by using this option, e.g. `--branch my-branch` or `-b my-branch`.
4+
</ParamField>

0 commit comments

Comments
 (0)