Skip to content

Commit 934cc04

Browse files
committed
rename references to test-projects, and removed a few that aren't being used anymore
1 parent bb7173b commit 934cc04

File tree

259 files changed

+453
-3815
lines changed

Some content is hidden

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

259 files changed

+453
-3815
lines changed

.dockerignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ docs
4040
examples
4141
out
4242
references
43+
test-projects
4344

4445
CHANGESETS.md
4546
CONTRIBUTING.md

CONTRIBUTING.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ branch are tagged into a release periodically.
1717
- [Node.js](https://nodejs.org/en) version 20.11.1
1818
- [pnpm package manager](https://pnpm.io/installation) version 8.15.5
1919
- [Docker](https://www.docker.com/get-started/)
20-
- [protobuf](https://github.com/protocolbuffers/protobuf)
2120

2221
### Setup
2322

@@ -62,8 +61,6 @@ branch are tagged into a release periodically.
6261
pnpm run docker
6362
```
6463

65-
This will also start and run a local instance of [pgAdmin](https://www.pgadmin.org/) on [localhost:5480](http://localhost:5480), preconfigured with email `admin@example.com` and pwd `admin`. Then use `postgres` as the password to the Trigger.dev server.
66-
6764
9. Migrate the database
6865
```
6966
pnpm run db:migrate
@@ -88,7 +85,7 @@ branch are tagged into a release periodically.
8885
8986
## Manual testing using v3-catalog
9087
91-
We use the `<root>/references/v3-catalog` 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 `v3-catalog` for local development of Trigger.dev (v3).
88+
We use the `<root>/test-projects/v3-catalog` 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 `v3-catalog` for local development of Trigger.dev (v3).
9289
9390
### First-time setup
9491
@@ -109,10 +106,10 @@ pnpm run build --filter trigger.dev
109106
pnpm i
110107
```
111108

112-
5. Change into the `<root>/references/v3-catalog` directory and authorize the CLI to the local server:
109+
5. Change into the `<root>/test-projects/v3-catalog` directory and authorize the CLI to the local server:
113110

114111
```sh
115-
cd references/v3-catalog
112+
cd test-projects/v3-catalog
116113
cp .env.example .env
117114
pnpm exec trigger login -a http://localhost:3030
118115
```
@@ -122,7 +119,7 @@ This will open a new browser window and authorize the CLI against your local use
122119
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:
123120

124121
```sh
125-
cd references/v3-catalog
122+
cd test-projects/v3-catalog
126123
pnpm exec trigger login -a http://localhost:3030 --profile local
127124
# later when you run the dev or deploy command:
128125
pnpm exec trigger dev --profile local
@@ -141,7 +138,7 @@ The following steps should be followed any time you start working on a new featu
141138
pnpm run dev --filter trigger.dev --filter "@trigger.dev/*"
142139
```
143140

144-
3. Open another terminal window, and change into the `<root>/references/v3-catalog` directory.
141+
3. Open another terminal window, and change into the `<root>/test-projects/v3-catalog` directory.
145142

146143
4. You'll need to run the following commands to setup prisma and migrate the database:
147144

@@ -153,22 +150,22 @@ pnpm run generate:prisma
153150
5. Run the `dev` command, which will register all the local tasks with the platform and allow you to start testing task execution:
154151

155152
```sh
156-
# in <root>/references/v3-catalog
153+
# in <root>/test-projects/v3-catalog
157154
pnpm exec trigger dev
158155
```
159156

160157
If you want additional debug logging, you can use the `--log-level debug` flag:
161158

162159
```sh
163-
# in <root>/references/v3-catalog
160+
# in <root>/test-projects/v3-catalog
164161
pnpm exec trigger dev --log-level debug
165162
```
166163

167164
6. 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 `v3-catalog/src/trigger` dir will automatically be rebuilt by the `dev` command.
168165

169166
7. Navigate to the `v3-catalog` project in your local dashboard at localhost:3030 and you should see the list of tasks.
170167

171-
8. 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/v3-catalog/src/trigger` folder. Many of them accept an empty payload.
168+
8. 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 `/test-projects/v3-catalog/src/trigger` folder. Many of them accept an empty payload.
172169

173170
9. Feel free to add additional files in `v3-catalog/src/trigger` to test out specific aspects of the system, or add in edge cases.
174171

@@ -180,14 +177,14 @@ To run the end-to-end tests, follow the steps below:
180177

181178
```sh
182179
cp ./.env.example ./.env
183-
cp ./references/nextjs-test/.env.example ./references/nextjs-test/.env.local
180+
cp ./test-projects/nextjs-test/.env.example ./test-projects/nextjs-test/.env.local
184181
```
185182

186183
2. Set up dependencies
187184

188185
```sh
189186
# Build packages
190-
pnpm run build --filter @references/nextjs-test^...
187+
pnpm run build --filter @test-projects/nextjs-test^...
191188
pnpm --filter @trigger.dev/database generate
192189

193190
# Move trigger-cli bin to correct place
@@ -251,9 +248,9 @@ This executes the migrations against your database and applies changes to the da
251248

252249
## Add sample jobs
253250

254-
The [references/job-catalog](./references/job-catalog/) project defines simple jobs you can get started with.
251+
The [test-projects/job-catalog](./test-projects/job-catalog/) project defines simple jobs you can get started with.
255252

256-
1. `cd` into `references/job-catalog`
253+
1. `cd` into `test-projects/job-catalog`
257254
2. Create a `.env` file with the following content,
258255
replacing `<TRIGGER_DEV_API_KEY>` with an actual key:
259256

@@ -277,7 +274,7 @@ This will open up a local server using `express` on port 8080. Then in a new ter
277274
pnpm run dev:trigger
278275
```
279276

280-
See the [Job Catalog](./references/job-catalog/README.md) file for more.
277+
See the [Job Catalog](./test-projects/job-catalog/README.md) file for more.
281278

282279
4. Navigate to your trigger.dev instance ([http://localhost:3030](http://localhost:3030/)), to see the jobs.
283280
You can use the test feature to trigger them.

ai/references/repo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This is a pnpm 8.15.5 monorepo that uses turborepo @turbo.json. The following wo
2727

2828
## References
2929

30-
- <root>/references/\* are test workspaces that we use to write and test the system. Not quite e2e tests or automated, but just a useful place to help develop new features
30+
- <root>/test-projects/\* are test workspaces that we use to write and test the system. Not quite e2e tests or automated, but just a useful place to help develop new features
3131

3232
## Other
3333

packages/cli-v3/DEVELOPMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ cd packages/cli-v3
77
pnpm run dev
88
```
99

10-
2. Test the local CLI using the job-catalogs located in the `/references` directory
10+
2. Test the local CLI using the job-catalogs located in the `/test-projects` directory
1111

1212
```sh
1313
pnpm i

0 commit comments

Comments
 (0)