Skip to content

Commit cf13fbd

Browse files
authored
Updating docs for the move from beta -> latest (with new build system) (#1299)
* Add triggerAndWait().unwrap() to more easily get at the output or throw the subtask error * Add taskId and runId to SubtaskUnwrapError * WIP docs update beta -> latest * trigger.dev init now adds @trigger.dev/build to devDependencies * How it works doc * Restructure some docs and update the cli commands * Config file docs, plus aptGet and ffmpeg extensions * Update to latest from beta docs * Add runtime to templates * Add --runtime option to the init CLI command * A bunch more doc updates after feedback * Document triggerAndWait with unwrap and result types * beta -> latest in the webapp * CLI update check no longer references beta * Add major release * Leave changeset beta, back to normal package release * Fixed default dirs option in init command * exclude windows-yarn variation of cli e2e tests because it’s buggy * Remove cache to try and fix yarn e2e test workflow errors
1 parent c738ef3 commit cf13fbd

File tree

65 files changed

+2443
-1125
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+2443
-1125
lines changed

.changeset/cuddly-penguins-cross.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
"@trigger.dev/sdk": major
3+
"trigger.dev": major
4+
"@trigger.dev/build": major
5+
"@trigger.dev/core": major
6+
---
7+
8+
Release 3.0.0

.changeset/itchy-jars-pay.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@trigger.dev/build": patch
3+
---
4+
5+
Add ffmpeg build extension

.changeset/ninety-countries-swim.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"trigger.dev": patch
3+
---
4+
5+
Add --runtime option to the init CLI command

.changeset/old-feet-brush.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"trigger.dev": patch
3+
---
4+
5+
trigger.dev init now adds @trigger.dev/build to devDependencies

.changeset/pre.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"mode": "pre",
2+
"mode": "exit",
33
"tag": "beta",
44
"initialVersions": {
55
"coordinator": "0.0.1",

.changeset/stale-actors-camp.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@trigger.dev/sdk": patch
3+
---
4+
5+
Add triggerAndWait().unwrap() to more easily get at the output or throw the subtask error

.changeset/thick-trains-work.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@trigger.dev/build": patch
3+
---
4+
5+
Add aptGet build extension to easily add system packages to install

.github/workflows/e2e.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ jobs:
1616
fail-fast: false
1717
matrix:
1818
os: [buildjet-8vcpu-ubuntu-2204, windows-latest]
19-
package-manager: ["npm", "pnpm", "yarn"]
20-
env:
21-
YARN_ENABLE_IMMUTABLE_INSTALLS: false
19+
package-manager: ["npm", "pnpm"]
2220
steps:
2321
- name: ⬇️ Checkout repo
2422
uses: actions/checkout@v3
@@ -34,7 +32,6 @@ jobs:
3432
uses: buildjet/setup-node@v3
3533
with:
3634
node-version: 20.11.1
37-
cache: "pnpm"
3835

3936
- name: 📥 Download deps
4037
run: pnpm install --frozen-lockfile --filter trigger.dev...

apps/webapp/app/components/SetupCommands.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export function TriggerDevStep({ extra }: { extra?: string }) {
132132
}
133133

134134
// Trigger.dev version 3 setup commands
135-
const v3PackageTag = "beta";
135+
const v3PackageTag = "latest";
136136

137137
function getApiUrlArg() {
138138
const appOrigin = useAppOrigin();

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.v3.$projectParam.runs.$runParam/route.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1147,7 +1147,7 @@ function ConnectedDevWarning() {
11471147
<Paragraph variant="small">
11481148
Runs usually start within 1 second in{" "}
11491149
<EnvironmentLabel environment={{ type: "DEVELOPMENT" }} />. Check you're running the
1150-
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@beta dev</InlineCode>
1150+
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@latest dev</InlineCode>
11511151
</Paragraph>
11521152
</div>
11531153
</Callout>

docs/cli-init-commands.mdx

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,32 @@ 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>
2424

2525
## Options
2626

27+
<ParamField body="Javascript" type="--javascript">
28+
By default, the init command assumes you are using TypeScript. Use this flag to initialize a
29+
project that uses JavaScript.
30+
</ParamField>
31+
2732
<ParamField body="Project ref" type="--project-ref | -p">
2833
The project ref to use when initializing the project.
2934
</ParamField>
3035

3136
<ParamField body="Package tag" type="--tag | -t">
32-
The version of the `@trigger.dev/sdk` package to install. Defaults to `3.0.0-beta.56`.
37+
The version of the `@trigger.dev/sdk` package to install. Defaults to `latest`.
3338
</ParamField>
3439

3540
<ParamField body="Skip package install" type="--skip-package-install">
@@ -53,7 +58,8 @@ yarn dlx trigger.dev@beta init
5358
</ParamField>
5459

5560
<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".
61+
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
62+
does not affect the log level of your trigger.dev tasks. Defaults to "log".
5763
</ParamField>
5864

5965
<ParamField body="Skip telemetry" type="--skip-telemetry">
@@ -64,4 +70,4 @@ yarn dlx trigger.dev@beta init
6470

6571
<ParamField body="Help" type="--help | -h">
6672
Shows the help information for the command.
67-
</ParamField>
73+
</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>

0 commit comments

Comments
 (0)