You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: move reference projects to their own repo (#3812)
The reference/example projects (`references/`) now live in their own
repo, https://github.com/triggerdotdev/references, so their heavy,
frequently-changing dependencies are no longer part of this repo's
lockfile and tooling. This removes them here and repoints everything
that referenced them.
- Deletes `references/`; updates the pnpm workspace + lockfile.
- Clears the references-only CI rules and `.vscode` configs.
- Repoints the docs (contributor/agent + one public page) to the new
repo.
- `seed.mts` keeps the local-dev projects (hello-world, d3-chat,
realtime-streams).
Copy file name to clipboardExpand all lines: AGENTS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This repository is a pnpm monorepo managed with Turbo. It contains multiple apps
7
7
-`apps/supervisor` – Node application for executing built tasks.
8
8
-`packages/*` – Published packages such as `@trigger.dev/sdk`, the CLI (`trigger.dev`), and shared libraries.
9
9
-`internal-packages/*` – Internal-only packages used by the webapp and other apps.
10
-
-`references/*` – Example projects for manual testing and development of new features.
10
+
-Example/reference projects for manual testing live in a separate repo: [`triggerdotdev/references`](https://github.com/triggerdotdev/references).
11
11
-`ai/references` – Contains additional documentation including an overview (`repo.md`) and testing guidelines (`tests.md`).
12
12
13
13
See `ai/references/repo.md` for a more complete explanation of the workspaces.
@@ -65,5 +65,5 @@ Refer to `ai/references/tests.md` for details on writing tests. Tests should avo
65
65
```bash
66
66
pnpm run dev --filter docs
67
67
```
68
-
-`references/README.md` explains how to create new reference projects for manual testing.
68
+
-The [`triggerdotdev/references`](https://github.com/triggerdotdev/references) repo's README explains how to create new reference projects for manual testing.
Copy file name to clipboardExpand all lines: CLAUDE.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,7 +138,7 @@ Docs live in `docs/` as a Mintlify site (MDX format). See `docs/CLAUDE.md` for c
138
138
139
139
### Reference Projects
140
140
141
-
The `references/` directory contains test workspaces for testing SDK and platform features. Use `references/hello-world` to manually test changes before submitting PRs.
141
+
Reference/example projects for testing SDK and platform features live in a separate repo: [`triggerdotdev/references`](https://github.com/triggerdotdev/references). Clone it alongside this repo and use its `projects/hello-world` to manually test changes before submitting PRs. See that repo's README for setup and linking to a local monorepo build.
The `rules/` directory contains versioned SDK documentation distributed via the SDK installer. Current version: `rules/manifest.json`. Do NOT update `rules/` or `.claude/skills/trigger-dev-tasks/` unless explicitly asked - these are maintained in separate dedicated passes.
169
169
170
-
## Testing with hello-world Reference Project
170
+
## Testing with the hello-world Reference Project
171
+
172
+
The reference projects live in the separate [`triggerdotdev/references`](https://github.com/triggerdotdev/references) repo - clone it alongside this repo.
3.Authorize: `cd references/hello-world && pnpm exec trigger login -a http://localhost:3030`
176
+
1.`pnpm run db:seed` to seed the database (creates the References org + hello-world project)
177
+
2. Build the CLI/packages you want to test: `pnpm run build --filter trigger.dev`
178
+
3.In your `references` clone, follow its README to link to your local monorepo build, then authorize: `cd projects/hello-world && pnpm exec trigger login -a http://localhost:3030`
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-15Lines changed: 23 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,24 +107,32 @@ branch are tagged into a release periodically.
107
107
108
108
## Manual testing using hello-world
109
109
110
-
We use the `<root>/references/hello-world` subdirectory as a staging ground for testing changes to the SDK (`@trigger.dev/sdk` at `<root>/packages/trigger-sdk`), the Core package (`@trigger.dev/core` at `<root>packages/core`), the CLI (`trigger.dev` at `<root>/packages/cli-v3`) and the platform (The remix app at `<root>/apps/webapp`). The instructions below will get you started on using the `hello-world` for local development of Trigger.dev.
110
+
The `hello-world` reference project (and the others) live in a separate repo:
111
+
[`triggerdotdev/references`](https://github.com/triggerdotdev/references). Clone it
112
+
alongside this repo. It's the staging ground for testing changes to the SDK
113
+
(`@trigger.dev/sdk` at `<root>/packages/trigger-sdk`), the Core package
114
+
(`@trigger.dev/core` at `<root>/packages/core`), the CLI (`trigger.dev` at
115
+
`<root>/packages/cli-v3`) and the platform (the Remix app at `<root>/apps/webapp`).
116
+
To exercise your local monorepo changes, the reference project links to your local
117
+
build — see the references repo's README for the `pnpm run link` flow.
118
+
119
+
> Paths below such as `projects/hello-world` are relative to your `references`
120
+
> clone, not this repo.
111
121
112
122
### First-time setup
113
123
114
124
First, make sure you are running the webapp according to the instructions above. The seed step from setup already created a `hello-world` project under the `References` org with the stable ref `proj_rrkpdguyagvsoktglnod` — log in at http://localhost:3030 with any email to access it. Then:
115
125
116
-
1. Build the CLI (skip if you already ran the build step in setup)
126
+
1. Build the CLI and packages (skip if you already ran the build step in setup)
117
127
118
128
```sh
119
-
pnpm run build --filter trigger.dev
120
-
# Make it accessible to `pnpm exec`
121
-
pnpm i
129
+
pnpm run build --filter trigger.dev --filter "@trigger.dev/*"
122
130
```
123
131
124
-
2.Change into the `<root>/references/hello-world` directory and authorize the CLI to the local server:
132
+
2.In your `references` clone, link to your local monorepo build (see its README), then change into `projects/hello-world` and authorize the CLI to the local server:
125
133
126
134
```sh
127
-
cdreferences/hello-world
135
+
cdprojects/hello-world
128
136
cp .env.example .env
129
137
pnpm exec trigger login -a http://localhost:3030
130
138
```
@@ -134,7 +142,7 @@ This will open a new browser window and authorize the CLI against your local use
134
142
You can optionally pass a `--profile` flag to the `login` command, which will allow you to use the CLI with separate accounts/servers. We suggest using a profile called `local` for your local development:
135
143
136
144
```sh
137
-
cdreferences/hello-world
145
+
cdprojects/hello-world
138
146
pnpm exec trigger login -a http://localhost:3030 --profile local
139
147
# later when you run the dev or deploy command:
140
148
pnpm exec trigger dev --profile local
@@ -147,35 +155,35 @@ The following steps should be followed any time you start working on a new featu
147
155
148
156
1. Make sure the webapp is running on localhost:3030
149
157
150
-
2.Open a terminal window and build the CLI and packages and watch for changes
158
+
2.In this repo, open a terminal window and build the CLI and packages and watch for changes (the reference project links against this build)
151
159
152
160
```sh
153
161
pnpm run dev --filter trigger.dev --filter "@trigger.dev/*"
154
162
```
155
163
156
-
3. Open another terminal window, and change into the `<root>/references/hello-world`directory.
164
+
3. Open another terminal window, and change into `projects/hello-world`in your `references` clone.
157
165
158
166
4. Run the `dev` command, which will register all the local tasks with the platform and allow you to start testing task execution:
159
167
160
168
```sh
161
-
# in <root>/references/hello-world
169
+
# in <references-clone>/projects/hello-world
162
170
pnpm exec trigger dev
163
171
```
164
172
165
173
If you want additional debug logging, you can use the `--log-level debug` flag:
166
174
167
175
```sh
168
-
# in <root>/references/hello-world
176
+
# in <references-clone>/projects/hello-world
169
177
pnpm exec trigger dev --log-level debug
170
178
```
171
179
172
-
5. If you make any changes in the CLI/Core/SDK, you'll need to `CTRL+C` to exit the `dev` command and restart it to pickup changes. Any changes to the files inside of the `hello-world/src/trigger` dir will automatically be rebuilt by the `dev` command.
180
+
5. If you make any changes in the CLI/Core/SDK, you'll need to `CTRL+C` to exit the `dev` command and restart it to pickup changes. Any changes to the files inside the reference project's `src/trigger` dir will automatically be rebuilt by the `dev` command.
173
181
174
182
6. Navigate to the `hello-world` project in your local dashboard at localhost:3030 and you should see the list of tasks.
175
183
176
-
7. Go to the "Test" page in the sidebar and select a task. Then enter a payload and click "Run test". You can tell what the payloads should be by looking at the relevant task file inside the `/references/hello-world/src/trigger` folder. Many of them accept an empty payload.
184
+
7. Go to the "Test" page in the sidebar and select a task. Then enter a payload and click "Run test". You can tell what the payloads should be by looking at the relevant task file inside the reference project's `src/trigger` folder. Many of them accept an empty payload.
177
185
178
-
8. Feel free to add additional files in `hello-world/src/trigger` to test out specific aspects of the system, or add in edge cases.
186
+
8. Feel free to add additional files in the reference project's `src/trigger` dir to test out specific aspects of the system, or add in edge cases.
0 commit comments