Skip to content

Updating docs for the move from beta -> latest (with new build system) #1299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/cuddly-penguins-cross.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@trigger.dev/sdk": major
"trigger.dev": major
"@trigger.dev/build": major
"@trigger.dev/core": major
---

Release 3.0.0
5 changes: 5 additions & 0 deletions .changeset/itchy-jars-pay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@trigger.dev/build": patch
---

Add ffmpeg build extension
5 changes: 5 additions & 0 deletions .changeset/ninety-countries-swim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"trigger.dev": patch
---

Add --runtime option to the init CLI command
5 changes: 5 additions & 0 deletions .changeset/old-feet-brush.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"trigger.dev": patch
---

trigger.dev init now adds @trigger.dev/build to devDependencies
2 changes: 1 addition & 1 deletion .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"mode": "pre",
"mode": "exit",
"tag": "beta",
"initialVersions": {
"coordinator": "0.0.1",
Expand Down
5 changes: 5 additions & 0 deletions .changeset/stale-actors-camp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@trigger.dev/sdk": patch
---

Add triggerAndWait().unwrap() to more easily get at the output or throw the subtask error
5 changes: 5 additions & 0 deletions .changeset/thick-trains-work.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@trigger.dev/build": patch
---

Add aptGet build extension to easily add system packages to install
5 changes: 1 addition & 4 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ jobs:
fail-fast: false
matrix:
os: [buildjet-8vcpu-ubuntu-2204, windows-latest]
package-manager: ["npm", "pnpm", "yarn"]
env:
YARN_ENABLE_IMMUTABLE_INSTALLS: false
package-manager: ["npm", "pnpm"]
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@v3
Expand All @@ -34,7 +32,6 @@ jobs:
uses: buildjet/setup-node@v3
with:
node-version: 20.11.1
cache: "pnpm"

- name: 📥 Download deps
run: pnpm install --frozen-lockfile --filter trigger.dev...
Expand Down
2 changes: 1 addition & 1 deletion apps/webapp/app/components/SetupCommands.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export function TriggerDevStep({ extra }: { extra?: string }) {
}

// Trigger.dev version 3 setup commands
const v3PackageTag = "beta";
const v3PackageTag = "latest";

function getApiUrlArg() {
const appOrigin = useAppOrigin();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1147,7 +1147,7 @@ function ConnectedDevWarning() {
<Paragraph variant="small">
Runs usually start within 1 second in{" "}
<EnvironmentLabel environment={{ type: "DEVELOPMENT" }} />. Check you're running the
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@beta dev</InlineCode>
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@latest dev</InlineCode>
</Paragraph>
</div>
</Callout>
Expand Down
18 changes: 12 additions & 6 deletions docs/cli-init-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,32 @@ Run the command like this:
<CodeGroup>

```bash npm
npx trigger.dev@beta init
npx trigger.dev@latest init
```

```bash pnpm
pnpm dlx trigger.dev@beta init
pnpm dlx trigger.dev@latest init
```

```bash yarn
yarn dlx trigger.dev@beta init
yarn dlx trigger.dev@latest init
```

</CodeGroup>

## Options

<ParamField body="Javascript" type="--javascript">
By default, the init command assumes you are using TypeScript. Use this flag to initialize a
project that uses JavaScript.
</ParamField>

<ParamField body="Project ref" type="--project-ref | -p">
The project ref to use when initializing the project.
</ParamField>

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

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

<ParamField body="Log level" type="--log-level | -l">
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".
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".
</ParamField>

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

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
</ParamField>
12 changes: 6 additions & 6 deletions docs/cli-list-profiles-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,32 @@ Run the command like this:
<CodeGroup>

```bash npm
npx trigger.dev@beta list-profiles
npx trigger.dev@latest list-profiles
```

```bash pnpm
pnpm dlx trigger.dev@beta list-profiles
pnpm dlx trigger.dev@latest list-profiles
```

```bash yarn
yarn dlx trigger.dev@beta list-profiles
yarn dlx trigger.dev@latest list-profiles
```

</CodeGroup>

## Options

<ParamField body="Log level" type="--log-level | -l">
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`.
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`.
</ParamField>

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


## Standard options

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
</ParamField>
11 changes: 6 additions & 5 deletions docs/cli-login-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Run the command like this:
<CodeGroup>

```bash npm
npx trigger.dev@beta login
npx trigger.dev@latest login
```

```bash pnpm
pnpm dlx trigger.dev@beta login
pnpm dlx trigger.dev@latest login
```

```bash yarn
yarn dlx trigger.dev@beta login
yarn dlx trigger.dev@latest login
```

</CodeGroup>
Expand All @@ -33,7 +33,8 @@ yarn dlx trigger.dev@beta login
</ParamField>

<ParamField body="Log level" type="-l | --log-level">
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`.
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`.
</ParamField>

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

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
</ParamField>
12 changes: 6 additions & 6 deletions docs/cli-logout-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Run the command like this:
<CodeGroup>

```bash npm
npx trigger.dev@beta logout
npx trigger.dev@latest logout
```

```bash pnpm
pnpm dlx trigger.dev@beta logout
pnpm dlx trigger.dev@latest logout
```

```bash yarn
yarn dlx trigger.dev@beta logout
yarn dlx trigger.dev@latest logout
```

</CodeGroup>
Expand All @@ -33,16 +33,16 @@ yarn dlx trigger.dev@beta logout
</ParamField>

<ParamField body="Log level" type="--log-level | -l">
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`.
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`.
</ParamField>

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


## Standard options

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
</ParamField>
12 changes: 6 additions & 6 deletions docs/cli-update-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,32 @@ Run the command like this:
<CodeGroup>

```bash npm
npx trigger.dev@beta update
npx trigger.dev@latest update
```

```bash pnpm
pnpm dlx trigger.dev@beta update
pnpm dlx trigger.dev@latest update
```

```bash yarn
yarn dlx trigger.dev@beta update
yarn dlx trigger.dev@latest update
```

</CodeGroup>

## Options

<ParamField body="Log level" type="--log-level | -l">
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`.
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`.
</ParamField>

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


## Standard options

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
</ParamField>
12 changes: 6 additions & 6 deletions docs/cli-whoami-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Run the command like this:
<CodeGroup>

```bash npm
npx trigger.dev@beta whoami
npx trigger.dev@latest whoami
```

```bash pnpm
pnpm dlx trigger.dev@beta whoami
pnpm dlx trigger.dev@latest whoami
```

```bash yarn
yarn dlx trigger.dev@beta whoami
yarn dlx trigger.dev@latest whoami
```

</CodeGroup>
Expand All @@ -33,16 +33,16 @@ yarn dlx trigger.dev@beta whoami
</ParamField>

<ParamField body="Log level" type="--log-level | -l">
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`.
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`.
</ParamField>

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


## Standard options

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
</ParamField>
Loading
Loading