Skip to content

Commit 136ff2d

Browse files
committed
WIP docs update beta -> latest
1 parent 16a1edb commit 136ff2d

28 files changed

+613
-136
lines changed

docs/cli-init-commands.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Run the command like this:
99
<CodeGroup>
1010

1111
```bash npm
12-
npx trigger.dev@beta init
12+
npx trigger.dev@latest init
1313
```
1414

1515
```bash pnpm
16-
pnpm dlx trigger.dev@beta init
16+
pnpm dlx trigger.dev@latest init
1717
```
1818

1919
```bash yarn
20-
yarn dlx trigger.dev@beta init
20+
yarn dlx trigger.dev@latest init
2121
```
2222

2323
</CodeGroup>
@@ -53,7 +53,8 @@ yarn dlx trigger.dev@beta init
5353
</ParamField>
5454

5555
<ParamField body="Log level" type="--log-level | -l">
56-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This does not affect the log level of your trigger.dev tasks. Defaults to "log".
56+
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
57+
does not affect the log level of your trigger.dev tasks. Defaults to "log".
5758
</ParamField>
5859

5960
<ParamField body="Skip telemetry" type="--skip-telemetry">
@@ -64,4 +65,4 @@ yarn dlx trigger.dev@beta init
6465

6566
<ParamField body="Help" type="--help | -h">
6667
Shows the help information for the command.
67-
</ParamField>
68+
</ParamField>

docs/cli-list-profiles-commands.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,32 @@ Run the command like this:
99
<CodeGroup>
1010

1111
```bash npm
12-
npx trigger.dev@beta list-profiles
12+
npx trigger.dev@latest list-profiles
1313
```
1414

1515
```bash pnpm
16-
pnpm dlx trigger.dev@beta list-profiles
16+
pnpm dlx trigger.dev@latest list-profiles
1717
```
1818

1919
```bash yarn
20-
yarn dlx trigger.dev@beta list-profiles
20+
yarn dlx trigger.dev@latest list-profiles
2121
```
2222

2323
</CodeGroup>
2424

2525
## Options
2626

2727
<ParamField body="Log level" type="--log-level | -l">
28-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This does not affect the log level of your trigger.dev tasks. Defaults to `log`.
28+
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
29+
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
2930
</ParamField>
3031

3132
<ParamField body="Skip telemetry" type="--skip-telemetry">
3233
Opt-out of sending telemetry data.
3334
</ParamField>
3435

35-
3636
## Standard options
3737

3838
<ParamField body="Help" type="--help | -h">
3939
Shows the help information for the command.
40-
</ParamField>
40+
</ParamField>

docs/cli-login-commands.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Run the command like this:
99
<CodeGroup>
1010

1111
```bash npm
12-
npx trigger.dev@beta login
12+
npx trigger.dev@latest login
1313
```
1414

1515
```bash pnpm
16-
pnpm dlx trigger.dev@beta login
16+
pnpm dlx trigger.dev@latest login
1717
```
1818

1919
```bash yarn
20-
yarn dlx trigger.dev@beta login
20+
yarn dlx trigger.dev@latest login
2121
```
2222

2323
</CodeGroup>
@@ -33,7 +33,8 @@ yarn dlx trigger.dev@beta login
3333
</ParamField>
3434

3535
<ParamField body="Log level" type="-l | --log-level">
36-
Sets the CLI log level. Available options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This setting doesn't affect the log level of your trigger.dev tasks. The default is `log`.
36+
Sets the CLI log level. Available options are `debug`, `info`, `log`, `warn`, `error`, and `none`.
37+
This setting doesn't affect the log level of your trigger.dev tasks. The default is `log`.
3738
</ParamField>
3839

3940
<ParamField body="Skip telemetry" type="--skip-telemetry">
@@ -48,4 +49,4 @@ yarn dlx trigger.dev@beta login
4849

4950
<ParamField body="Help" type="--help | -h">
5051
Shows the help information for the command.
51-
</ParamField>
52+
</ParamField>

docs/cli-logout-commands.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Run the command like this:
99
<CodeGroup>
1010

1111
```bash npm
12-
npx trigger.dev@beta logout
12+
npx trigger.dev@latest logout
1313
```
1414

1515
```bash pnpm
16-
pnpm dlx trigger.dev@beta logout
16+
pnpm dlx trigger.dev@latest logout
1717
```
1818

1919
```bash yarn
20-
yarn dlx trigger.dev@beta logout
20+
yarn dlx trigger.dev@latest logout
2121
```
2222

2323
</CodeGroup>
@@ -33,16 +33,16 @@ yarn dlx trigger.dev@beta logout
3333
</ParamField>
3434

3535
<ParamField body="Log level" type="--log-level | -l">
36-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This does not affect the log level of your trigger.dev tasks. Defaults to `log`.
36+
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
37+
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
3738
</ParamField>
3839

3940
<ParamField body="Skip telemetry" type="--skip-telemetry">
4041
Opt-out of sending telemetry data.
4142
</ParamField>
4243

43-
4444
## Standard options
4545

4646
<ParamField body="Help" type="--help | -h">
4747
Shows the help information for the command.
48-
</ParamField>
48+
</ParamField>

docs/cli-update-commands.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,32 @@ Run the command like this:
99
<CodeGroup>
1010

1111
```bash npm
12-
npx trigger.dev@beta update
12+
npx trigger.dev@latest update
1313
```
1414

1515
```bash pnpm
16-
pnpm dlx trigger.dev@beta update
16+
pnpm dlx trigger.dev@latest update
1717
```
1818

1919
```bash yarn
20-
yarn dlx trigger.dev@beta update
20+
yarn dlx trigger.dev@latest update
2121
```
2222

2323
</CodeGroup>
2424

2525
## Options
2626

2727
<ParamField body="Log level" type="--log-level | -l">
28-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This does not affect the log level of your trigger.dev tasks. Defaults to `log`.
28+
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
29+
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
2930
</ParamField>
3031

3132
<ParamField body="Skip telemetry" type="--skip-telemetry">
3233
Opt-out of sending telemetry data.
3334
</ParamField>
3435

35-
3636
## Standard options
3737

3838
<ParamField body="Help" type="--help | -h">
3939
Shows the help information for the command.
40-
</ParamField>
40+
</ParamField>

docs/cli-whoami-commands.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Run the command like this:
99
<CodeGroup>
1010

1111
```bash npm
12-
npx trigger.dev@beta whoami
12+
npx trigger.dev@latest whoami
1313
```
1414

1515
```bash pnpm
16-
pnpm dlx trigger.dev@beta whoami
16+
pnpm dlx trigger.dev@latest whoami
1717
```
1818

1919
```bash yarn
20-
yarn dlx trigger.dev@beta whoami
20+
yarn dlx trigger.dev@latest whoami
2121
```
2222

2323
</CodeGroup>
@@ -33,16 +33,16 @@ yarn dlx trigger.dev@beta whoami
3333
</ParamField>
3434

3535
<ParamField body="Log level" type="--log-level | -l">
36-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This does not affect the log level of your trigger.dev tasks. Defaults to `log`.
36+
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
37+
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
3738
</ParamField>
3839

3940
<ParamField body="Skip telemetry" type="--skip-telemetry">
4041
Opt-out of sending telemetry data.
4142
</ParamField>
4243

43-
4444
## Standard options
4545

4646
<ParamField body="Help" type="--help | -h">
4747
Shows the help information for the command.
48-
</ParamField>
48+
</ParamField>

docs/trigger-config.mdx renamed to docs/config/config-file.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebarTitle: "trigger.config file"
44
description: "This file is used to configure your project and how it's bundled."
55
---
66

7-
import BundlePackages from '/snippets/bundle-packages.mdx';
7+
import BundlePackages from "/snippets/bundle-packages.mdx";
88

99
Let's take a look at a basic `trigger.config.ts` file. This is generated for you when you follow [the quick start guide](/quick-start). This file is used to configure your project and how it's bundled.
1010

@@ -112,7 +112,7 @@ You can sync environment variables from another service using the `resolveEnvVar
112112

113113
We'll let you know when running the CLI dev command if this is a problem. Some packages are ESM-only so they don't work directly from CJS when using Node.js. In that case you need to add them to the `dependenciesToBundle` array in your `trigger.config.ts` file.
114114

115-
<BundlePackages/>
115+
<BundlePackages />
116116

117117
## Prisma (and other generators)
118118

docs/config/extensions/custom.mdx

Whitespace-only changes.

docs/config/extensions/esbuild-plugins.mdx

Whitespace-only changes.

docs/config/extensions/overview.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Overview"
3+
sidebarTitle: "Overview"
4+
description: "This file is used to configure your project and how it's bundled."
5+
---

docs/config/extensions/prisma.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Prisma"
3+
sidebarTitle: "Prisma"
4+
description: "This file is used to configure your project and how it's bundled."
5+
---

docs/github-actions.mdx

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
env:
4242
TRIGGER_ACCESS_TOKEN: ${{ secrets.TRIGGER_ACCESS_TOKEN }}
4343
run: |
44-
npx trigger.dev@beta deploy
44+
npx trigger.dev@latest deploy
4545
```
4646
4747
```yaml .github/workflows/release-trigger-staging.yml
@@ -70,7 +70,7 @@ jobs:
7070
env:
7171
TRIGGER_ACCESS_TOKEN: ${{ secrets.TRIGGER_ACCESS_TOKEN }}
7272
run: |
73-
npx trigger.dev@beta deploy --env staging
73+
npx trigger.dev@latest deploy --env staging
7474
```
7575
7676
</CodeGroup>
@@ -81,16 +81,22 @@ If you already have a GitHub action file, you can just add the final step "🚀
8181
8282
<Steps>
8383
84-
<Step title="Create a new access token">Go to your profile page and click on the ["Personal Access Tokens"](https://cloud.trigger.dev/account/tokens) tab.</Step>
84+
<Step title="Create a new access token">
85+
Go to your profile page and click on the ["Personal Access
86+
Tokens"](https://cloud.trigger.dev/account/tokens) tab.
87+
</Step>
8588
86-
<Step title="Go to your repository on GitHub.">Click on 'Settings' -> 'Secrets and variables' -> 'Actions' -> 'New repository secret'</Step>
89+
<Step title="Go to your repository on GitHub.">
90+
Click on 'Settings' -> 'Secrets and variables' -> 'Actions' -> 'New repository secret'
91+
</Step>
8792
88-
<Step title="Add the TRIGGER_ACCESS_TOKEN">Add the name `TRIGGER_ACCESS_TOKEN` and the value of your access token. ![Add TRIGGER_ACCESS_TOKEN in GitHub](/images/github-access-token.png)</Step>
93+
<Step title="Add the TRIGGER_ACCESS_TOKEN">
94+
Add the name `TRIGGER_ACCESS_TOKEN` and the value of your access token. ![Add TRIGGER_ACCESS_TOKEN
95+
in GitHub](/images/github-access-token.png)
96+
</Step>
8997

9098
</Steps>
9199

92-
93-
94100
## Version pinning
95101

96102
The CLI and `@trigger.dev/*` package versions need to be in sync, otherwise there will be errors and unpredictable behavior. Hence, the `deploy` command will automatically fail during CI on any version mismatches.
@@ -104,6 +110,7 @@ Tip: add the deploy command to your `package.json` file to keep versions managed
104110
}
105111
}
106112
```
113+
107114
Your workflow file will follow the version specified in the `package.json` script, like so:
108115

109116
```yaml .github/workflows/release-trigger.yml

0 commit comments

Comments
 (0)