docs: update schedule & test navigation for the new dashboard UI (#4252)
The dashboard was redesigned and two pages moved, but the docs still described the old sidebar: - **Schedules** no longer has its own sidebar page — schedules are managed from the **Tasks** page (open a scheduled task to create / view / edit / enable-disable / delete them). - The standalone list-based **Test** page is deprecated — you test a task from its own **Test** button now. ## Changes - `tasks/scheduled.mdx`: rewrote the "attaching schedules" and "testing schedules" sections for the Tasks-based flow, added a "managing schedules in the dashboard" section, and added explicit callouts noting both pages moved (so readers — and search — aren't pointed at a page that no longer exists). Re-shot the four schedule screenshots and fixed a mislabeled alt text. - `run-tests.mdx`, `snippets/step-run-test.mdx`, `guides/examples/sentry-error-tracking.mdx`: replaced "select the Test page in the sidebar" with the task-first flow plus a callout, and refreshed `test-dashboard.png`. TRI-11939
@@ -169,7 +169,7 @@ After creating the task, deploy your project.
|
||||
|
||||
</CodeGroup>
|
||||
|
||||
Once deployed, navigate to the `test` page in the sidebar of your [Trigger.dev dashboard](https://cloud.trigger.dev), click on your `prod` environment, and select the `sentryErrorTest` task.
|
||||
Once deployed, open the `sentry-error-test` task in your [Trigger.dev dashboard](https://cloud.trigger.dev) (make sure you're in your `prod` environment) and press the "Test" button to open the test page for it.
|
||||
|
||||
Run a test task with an empty payload by clicking the `Run test` button.
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 166 KiB |
|
Before Width: | Height: | Size: 150 KiB After Width: | Height: | Size: 347 KiB |
|
Before Width: | Height: | Size: 213 KiB After Width: | Height: | Size: 314 KiB |
|
Before Width: | Height: | Size: 148 KiB After Width: | Height: | Size: 347 KiB |
|
Before Width: | Height: | Size: 356 KiB After Width: | Height: | Size: 450 KiB |
@@ -3,18 +3,19 @@ title: "Run tests"
|
||||
description: "You can use the dashboard to run a test of your tasks."
|
||||
---
|
||||
|
||||
From the "Test" page in the side menu of the dashboard you can run a test for any of your tasks from any environment.
|
||||
You can run a test for any of your tasks, in any environment, from the dashboard.
|
||||
|
||||

|
||||
<Note>
|
||||
There is no longer a "Test" page in the sidebar. You test a task from the task itself: on the
|
||||
Tasks page open a task (or use the "Test" action next to a task in the Runs list) and press the
|
||||
"Test" button to open its test page.
|
||||
</Note>
|
||||
|
||||
<Icon icon="circle-1" iconType="solid" color="#FF2D6B" size="20" /> Select a task to test
|
||||
On a task's test page you can:
|
||||
|
||||
<Icon icon="circle-2" iconType="solid" color="#FF2D6B" size="20" /> Include a payload or metadata
|
||||
- Enter the run's input — a JSON **payload** and optional **metadata**. Scheduled tasks show timestamp fields instead of a payload.
|
||||
- Configure run **options** like the machine size, version, queue, tags, retries, max duration, or a delay.
|
||||
- Pre-populate the form from a previous run with **Recent runs**, or save and reuse a configuration with **Templates**.
|
||||
- Press **Run test** to trigger the run.
|
||||
|
||||
<Icon icon="circle-3" iconType="solid" color="#FF2D6B" size="20" /> Configure any additional options like the machine size, queue or delay
|
||||
|
||||
<Icon icon="circle-4" iconType="solid" color="#FF2D6B" size="20" /> Select from previous test runs
|
||||
|
||||
<Icon icon="circle-5" iconType="solid" color="#FF2D6B" size="20" /> Save the current test configuration as a template for later
|
||||
|
||||
<Icon icon="circle-6" iconType="solid" color="#FF2D6B" size="20" /> Run the test
|
||||

|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
<Step title="Perform a test run using the dashboard">
|
||||
|
||||
The CLI `dev` command spits out various useful URLs. Right now we want to visit the Test page.
|
||||
The CLI `dev` command spits out various useful URLs, including a link to the dashboard. Open it, find your Example task on the Tasks page, and press the "Test" button to open its test page.
|
||||
|
||||
You should see our Example task in the list <Icon icon="circle-1" iconType="solid" size={20} color="F43F47" />, select it. Most tasks have a "payload" which you enter in the JSON editor <Icon icon="circle-2" iconType="solid" size={20} color="F43F47" />, but our example task doesn't need any input.
|
||||
Most tasks have a "payload" which you enter in the JSON editor, but our example task doesn't need any input. You can also configure run options, pre-populate the form from recent runs, and save run templates.
|
||||
|
||||
You can configure options on the run <Icon icon="circle-3" iconType="solid" size={20} color="F43F47" />, view recent payloads <Icon icon="circle-4" iconType="solid" size={20} color="F43F47" />, and create run templates <Icon icon="circle-5" iconType="solid" size={20} color="F43F47" />.
|
||||
|
||||
Press the "Run test" button <Icon icon="circle-6" iconType="solid" size={20} color="F43F47" />.
|
||||
Press the "Run test" button.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -127,11 +127,11 @@ export const secondScheduledTask = schedules.task({
|
||||
});
|
||||
```
|
||||
|
||||
When you run the [dev](/cli-dev-commands) or [deploy](/cli-deploy-commands) commands, declarative schedules will be synced. If you add, delete or edit the `cron` property it will be updated when you run these commands. You can view your schedules on the Schedules page in the dashboard.
|
||||
When you run the [dev](/cli-dev-commands) or [deploy](/cli-deploy-commands) commands, declarative schedules will be synced. If you add, delete or edit the `cron` property it will be updated when you run these commands. You can view your synced schedules in the dashboard: open the task on the Tasks page and check its "Schedules" tab.
|
||||
|
||||
### Imperative schedules
|
||||
|
||||
Alternatively you can explicitly attach schedules to a `schedules.task`. You can do this in the Schedules page in the dashboard by just pressing the "New schedule" button, or you can use the SDK to create schedules.
|
||||
Alternatively you can explicitly attach schedules to a `schedules.task`. You can do this in the dashboard from the scheduled task's page by pressing the "Create schedule" button, or you can use the SDK to create schedules.
|
||||
|
||||
The advantage of imperative schedules is that they can be created dynamically, for example, you could create a schedule for each user in your database. They can also be activated, disabled, edited, and deleted without deploying new code by using the SDK or dashboard.
|
||||
|
||||
@@ -166,26 +166,37 @@ There are two situations when a scheduled task won't trigger:
|
||||
|
||||
## Attaching schedules in the dashboard
|
||||
|
||||
You need to attach a schedule to a task before it will run on a schedule. You can attach static schedules in the dashboard:
|
||||
You need to attach a schedule to a task before it will run on a schedule. You can attach imperative schedules in the dashboard:
|
||||
|
||||
<Note>
|
||||
**The Schedules page has moved.** There is no longer a standalone "Schedules" page in the
|
||||
sidebar. Schedules now live on the Tasks page: open a scheduled task to create, view, edit,
|
||||
enable/disable, and delete its schedules. The old `/schedules` URL redirects to the Tasks page.
|
||||
|
||||
The scheduled task must already exist first — define it in your code with `schedules.task()` and
|
||||
sync it to the environment by running the [dev](/cli-dev-commands) or
|
||||
[deploy](/cli-deploy-commands) command so it appears on the Tasks page. A project with no tasks
|
||||
yet will only show the deploy onboarding.
|
||||
</Note>
|
||||
|
||||
<Steps>
|
||||
|
||||
<Step title="Go to the Schedules page">
|
||||
In the sidebar select the "Schedules" page, then press the "New schedule" button. Or you can
|
||||
follow the onboarding and press the create in dashboard button. 
|
||||
<Step title="Open the scheduled task">
|
||||
In the sidebar select the "Tasks" page, then select the scheduled task you want to attach a
|
||||
schedule to (scheduled tasks have a clock icon, and you can filter the list to Scheduled).
|
||||

|
||||
</Step>
|
||||
|
||||
<Step title="Create your schedule">
|
||||
Fill in the form and press "Create schedule" when you're done. 
|
||||
Press the "Create schedule" button, fill in the form, and press "Create schedule" when you're
|
||||
done. 
|
||||
|
||||
These are the options when creating a schedule:
|
||||
|
||||
| Name | Description |
|
||||
| ----------------- | --------------------------------------------------------------------------------------------- |
|
||||
| Task | The id of the task you want to attach to. |
|
||||
| Cron pattern | The schedule in cron format. |
|
||||
| Cron pattern | The schedule in cron format. You can also describe it in natural language and press "Generate" to fill this in. |
|
||||
| Timezone | The timezone the schedule will run in. Defaults to "UTC" |
|
||||
| External id | An optional external id, usually you'd use a userId. |
|
||||
| Deduplication key | An optional deduplication key. If you pass the same value, it will update rather than create. Scoped per project, not per environment. |
|
||||
@@ -195,6 +206,12 @@ These are the options when creating a schedule:
|
||||
|
||||
</Steps>
|
||||
|
||||
## Managing schedules in the dashboard
|
||||
|
||||
Open the scheduled task and switch to the "Schedules" tab to see every schedule attached to it — both declarative and imperative — with its type, cron pattern, external id, next and last run, and status.
|
||||
|
||||
Click a schedule to open the inspector, where you can **enable/disable**, **edit**, or **delete** imperative schedules without deploying new code. Declarative schedules are managed in your code, so they can't be edited or deleted from here.
|
||||
|
||||
## Attaching schedules with the SDK
|
||||
|
||||
You call `schedules.create()` to create a schedule from your code. Here's the simplest possible example:
|
||||
@@ -302,14 +319,19 @@ You can also retrieve, list, delete, deactivate and re-activate schedules using
|
||||
|
||||
You can test a scheduled task in the dashboard. Note that the `scheduleId` will always come through as `sched_1234` to the run.
|
||||
|
||||
<Note>
|
||||
There is no longer a standalone "Test" page in the sidebar. You test a task from the task itself —
|
||||
open it on the Tasks page and press the "Test schedule" button.
|
||||
</Note>
|
||||
|
||||
<Steps>
|
||||
|
||||
<Step title="Go to the Test page">
|
||||
In the sidebar select the "Test" page, then select a scheduled task from the list (they have a
|
||||
clock icon on them) 
|
||||
<Step title="Open the test page for your task">
|
||||
On the "Tasks" page, open your scheduled task and press the "Test schedule" button.
|
||||

|
||||
</Step>
|
||||
|
||||
<Step title="Create your schedule">
|
||||
<Step title="Run the test">
|
||||
Fill in the form [1]. You can select from a recent run [2] to pre-populate the fields. Press "Run
|
||||
test" when you're ready 
|
||||
</Step>
|
||||
|
||||