Skip to content

Commit 688b108

Browse files
authored
chore(references): remove v3-catalog (#2443)
1 parent 1cc6223 commit 688b108

Some content is hidden

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

75 files changed

+179
-10163
lines changed

.vscode/launch.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"request": "launch",
6060
"name": "Debug V3 Dev CLI",
6161
"command": "pnpm exec trigger dev",
62-
"cwd": "${workspaceFolder}/references/v3-catalog",
62+
"cwd": "${workspaceFolder}/references/hello-world",
6363
"sourceMaps": true
6464
},
6565
{
@@ -83,31 +83,31 @@
8383
"request": "launch",
8484
"name": "Debug V3 Deploy CLI",
8585
"command": "pnpm exec trigger deploy --self-hosted --load-image",
86-
"cwd": "${workspaceFolder}/references/v3-catalog",
86+
"cwd": "${workspaceFolder}/references/hello-world",
8787
"sourceMaps": true
8888
},
8989
{
9090
"type": "node-terminal",
9191
"request": "launch",
9292
"name": "Debug V3 list-profiles CLI",
9393
"command": "pnpm exec trigger list-profiles --log-level debug",
94-
"cwd": "${workspaceFolder}/references/v3-catalog",
94+
"cwd": "${workspaceFolder}/references/hello-world",
9595
"sourceMaps": true
9696
},
9797
{
9898
"type": "node-terminal",
9999
"request": "launch",
100100
"name": "Debug V3 update CLI",
101101
"command": "pnpm exec trigger update",
102-
"cwd": "${workspaceFolder}/references/v3-catalog",
102+
"cwd": "${workspaceFolder}/references/hello-world",
103103
"sourceMaps": true
104104
},
105105
{
106106
"type": "node-terminal",
107107
"request": "launch",
108108
"name": "Debug V3 Management",
109109
"command": "pnpm run management",
110-
"cwd": "${workspaceFolder}/references/v3-catalog",
110+
"cwd": "${workspaceFolder}/references/hello-world",
111111
"sourceMaps": true
112112
},
113113
{

CONTRIBUTING.md

Lines changed: 15 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,17 @@ branch are tagged into a release periodically.
8484
8585
2. Once the app is running click the magic link button and enter your email. You will automatically be logged in, since you are running locally. Create an Org and your first project in the dashboard.
8686
87-
## Manual testing using v3-catalog
87+
## Manual testing using hello-world
8888
89-
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).
89+
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.
9090
9191
### First-time setup
9292
9393
First, make sure you are running the webapp according to the instructions above. Then:
9494
95-
1. Visit http://localhost:3030 in your browser and create a new V3 project called "v3-catalog".
95+
1. Visit http://localhost:3030 in your browser and create a new V3 project called "hello-world".
9696
97-
2. In Postgres go to the "Projects" table and for the project you create change the `externalRef` to `yubjwjsfkxnylobaqvqz`.
97+
2. In Postgres go to the "Projects" table and for the project you create change the `externalRef` to `proj_rrkpdguyagvsoktglnod`.
9898
9999
3. Build the CLI
100100
@@ -105,10 +105,10 @@ pnpm run build --filter trigger.dev
105105
pnpm i
106106
```
107107

108-
4. Change into the `<root>/references/v3-catalog` directory and authorize the CLI to the local server:
108+
4. Change into the `<root>/references/hello-world` directory and authorize the CLI to the local server:
109109

110110
```sh
111-
cd references/v3-catalog
111+
cd references/hello-world
112112
cp .env.example .env
113113
pnpm exec trigger login -a http://localhost:3030
114114
```
@@ -118,7 +118,7 @@ This will open a new browser window and authorize the CLI against your local use
118118
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:
119119

120120
```sh
121-
cd references/v3-catalog
121+
cd references/hello-world
122122
pnpm exec trigger login -a http://localhost:3030 --profile local
123123
# later when you run the dev or deploy command:
124124
pnpm exec trigger dev --profile local
@@ -137,84 +137,29 @@ The following steps should be followed any time you start working on a new featu
137137
pnpm run dev --filter trigger.dev --filter "@trigger.dev/*"
138138
```
139139

140-
3. Open another terminal window, and change into the `<root>/references/v3-catalog` directory.
140+
3. Open another terminal window, and change into the `<root>/references/hello-world` directory.
141141

142-
4. You'll need to run the following commands to setup prisma and migrate the database:
142+
4. Run the `dev` command, which will register all the local tasks with the platform and allow you to start testing task execution:
143143

144144
```sh
145-
pnpm exec prisma migrate deploy
146-
pnpm run generate:prisma
147-
```
148-
149-
5. Run the `dev` command, which will register all the local tasks with the platform and allow you to start testing task execution:
150-
151-
```sh
152-
# in <root>/references/v3-catalog
145+
# in <root>/references/hello-world
153146
pnpm exec trigger dev
154147
```
155148

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

158151
```sh
159-
# in <root>/references/v3-catalog
152+
# in <root>/references/hello-world
160153
pnpm exec trigger dev --log-level debug
161154
```
162155

163-
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.
164-
165-
7. Navigate to the `v3-catalog` project in your local dashboard at localhost:3030 and you should see the list of tasks.
166-
167-
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-
169-
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.
170-
171-
## Running end-to-end webapp tests (deprecated)
156+
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 `hello-world/src/trigger` dir will automatically be rebuilt by the `dev` command.
172157

173-
To run the end-to-end tests, follow the steps below:
174-
175-
1. Set up environment variables (copy example envs into the correct place)
176-
177-
```sh
178-
cp ./.env.example ./.env
179-
cp ./references/nextjs-test/.env.example ./references/nextjs-test/.env.local
180-
```
181-
182-
2. Set up dependencies
183-
184-
```sh
185-
# Build packages
186-
pnpm run build --filter @references/nextjs-test^...
187-
pnpm --filter @trigger.dev/database generate
158+
7. Navigate to the `hello-world` project in your local dashboard at localhost:3030 and you should see the list of tasks.
188159

189-
# Move trigger-cli bin to correct place
190-
pnpm install --frozen-lockfile
160+
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/hello-world/src/trigger` folder. Many of them accept an empty payload.
191161

192-
# Install playwrite browsers (ONE TIME ONLY)
193-
npx playwright install
194-
```
195-
196-
3. Set up the database
197-
198-
```sh
199-
pnpm run docker
200-
pnpm run db:migrate
201-
pnpm run db:seed
202-
```
203-
204-
4. Run the end-to-end tests
205-
206-
```sh
207-
pnpm run test:e2e
208-
```
209-
210-
### Cleanup
211-
212-
The end-to-end tests use a `setup` and `teardown` script to seed the database with test data. If the test runner doesn't exit cleanly, then the database can be left in a state where the tests can't run because the `setup` script will try to create data that already exists. If this happens, you can manually delete the `users` and `organizations` from the database using prisma studio:
213-
214-
```sh
215-
# With the database running (i.e. pnpm run docker)
216-
pnpm run db:studio
217-
```
162+
9. Feel free to add additional files in `hello-world/src/trigger` to test out specific aspects of the system, or add in edge cases.
218163

219164
## Adding and running migrations
220165

packages/cli-v3/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -955,7 +955,7 @@
955955
port: 5432,
956956
username: "postgres",
957957
password: "postgres",
958-
database: "v3-catalog",
958+
database: "hello-world",
959959
entities: [Photo],
960960
synchronize: true,
961961
logging: false,
@@ -1591,7 +1591,7 @@
15911591
port: 5432,
15921592
username: "postgres",
15931593
password: "postgres",
1594-
database: "v3-catalog",
1594+
database: "hello-world",
15951595
entities: [Photo],
15961596
synchronize: true,
15971597
logging: false,

packages/core/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@
616616
port: 5432,
617617
username: "postgres",
618618
password: "postgres",
619-
database: "v3-catalog",
619+
database: "hello-world",
620620
entities: [Photo],
621621
synchronize: true,
622622
logging: false,
@@ -1056,7 +1056,7 @@
10561056
port: 5432,
10571057
username: "postgres",
10581058
password: "postgres",
1059-
database: "v3-catalog",
1059+
database: "hello-world",
10601060
entities: [Photo],
10611061
synchronize: true,
10621062
logging: false,

0 commit comments

Comments
 (0)