Skip to content

Commit efa65bb

Browse files
committed
Added dashboard section to the docs
1 parent 44307a6 commit efa65bb

File tree

4 files changed

+10
-11
lines changed

4 files changed

+10
-11
lines changed
259 KB
Loading
53 KB
Loading

docs/deployment/preview-branches.mdx

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ Notice that the deploy command has `--env preview` at the end. We automatically
8282

8383
You can manually specify the branch using `--branch <branch-name>` in the deploy command, but this isn't required.
8484

85-
## Manually creating, deploying and archiving preview branches
85+
## Using the CLI to create, deploy and archive preview branches
8686

87-
### Using the CLI
87+
### Deploying a preview branch
8888

8989
Creating and deploying a preview branch manually is easy:
9090

@@ -98,6 +98,8 @@ This will create and deploy a preview branch, automatically detecting the git br
9898
npx trigger.dev@v4-beta deploy --env preview --branch <branch-name>
9999
```
100100

101+
### Archiving a preview branch
102+
101103
You can manually archive a preview branch with the CLI:
102104

103105
```bash
@@ -106,16 +108,13 @@ npx trigger.dev@v4-beta preview archive
106108

107109
Again we will try auto-detect the current branch. But you can specify the branch name with `--branch <branch-name>`.
108110

109-
### In the dashboard
110-
111-
### Creating and archiving preview branches from the dashboard
112-
113-
In the dashboard, you can
111+
## Creating and archiving preview branches from the dashboard
114112

115-
## Automating using GitHub Actions
113+
From the "Preview branches" page you can create a branch:
116114

117-
## Limits
115+
![Preview branches page](/deployment/preview-branches.png)
116+
![Create preview branch](/deployment/preview-branches-new.png)
118117

119-
## Triggering runs on preview branches
118+
You can also archive a branch:
120119

121-
When triggering runs for a preview branch you need to both set the `TRIGGER_SECRET_KEY` (to your Preview API key) and set `TRIGGER_PREVIEW_BRANCH` to the name of your branch.
120+
![Archive preview branch](/deployment/preview-branches-archive.png)

docs/deployment/preview-branches.png

252 KB
Loading

0 commit comments

Comments
 (0)