Skip to content

Commit 486ed20

Browse files
ericallamericallam
committed
Renamed the examples dir to references (true examples are in another repo and this was confusing)
1 parent e5ffc3a commit 486ed20

178 files changed

Lines changed: 1573 additions & 2290 deletions

File tree

Some content is hidden

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

‎.changeset/calm-hornets-laugh.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@trigger.dev/testing": patch
3+
"@trigger.dev/cli": patch
4+
---
5+
6+
Moved examples to references in the monorepo

‎.dockerignore‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,43 @@
1-
*.log
1+
\*.log
22
.git
33
.github
4+
45
# editor
6+
57
.idea
68
.vscode
9+
710
# dependencies
11+
812
node_modules
913
.pnp
1014
.pnp.js
1115

1216
# testing
17+
1318
coverage
1419

1520
# next.js
21+
1622
.next/
1723
build
1824

1925
# packages
26+
2027
build
2128
dist
22-
packages/**/dist
29+
packages/\*\*/dist
2330

2431
# misc
32+
2533
.DS_Store
26-
*.pem
34+
\*.pem
2735

2836
.turbo
2937
.vercel
3038
.cache
3139
.output
32-
apps/**/public/build
40+
apps/\*\*/public/build
3341

3442
cypress/screenshots
3543
cypress/videos
@@ -38,6 +46,7 @@ apps/**/styles/tailwind.css
3846
packages/**/styles/tailwind.css
3947

4048
.changeset
49+
references
4150
examples
4251
CHANGESETS.md
4352
CONTRIBUTING.md

‎.github/workflows/publish.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,10 +129,10 @@ jobs:
129129
run: |
130130
# Setup environment variables
131131
cp ./.env.example ./.env
132-
cp ./examples/nextjs-test/.env.example ./examples/nextjs-test/.env.local
132+
cp ./references/nextjs-test/.env.example ./references/nextjs-test/.env.local
133133
134134
# Build packages
135-
pnpm run build --filter @examples/nextjs-test^...
135+
pnpm run build --filter @references/nextjs-test^...
136136
pnpm --filter @trigger.dev/database generate
137137
138138
# Move trigger-cli bin to correct place

‎CONTRIBUTING.md‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,10 @@ pnpm run dev
133133

134134
2. Open a new Terminal window and run the webapp locally and then create a new project in the dashboard. Copy out the dev API key.
135135

136-
3. Create a new temporary Next.js app in examples directory
136+
3. Create a new temporary Next.js app in references directory
137137

138138
```sh
139-
cd ./examples
139+
cd ./references
140140
pnpm create next-app@latest test-cli --ts --no-eslint --tailwind --app --src-dir --import-alias "@/*"
141141
```
142142

@@ -149,7 +149,7 @@ pnpm create next-app@latest test-cli --ts --no-eslint --tailwind --app --src-dir
149149
}
150150
```
151151
152-
5. Back in the terminal, navigate into the example, and initialize the CLI. When prompted, select `self-hosted` and enter `localhost:3030` if you are testing against the local instance of Trigger.dev, or you can just use the Trigger.dev cloud. When asked for an API key, use the key you copied earlier.
152+
5. Back in the terminal, navigate into the reference, and initialize the CLI. When prompted, select `self-hosted` and enter `localhost:3030` if you are testing against the local instance of Trigger.dev, or you can just use the Trigger.dev cloud. When asked for an API key, use the key you copied earlier.
153153
154154
```sh
155155
cd ./test-cli
@@ -179,14 +179,14 @@ To run the end-to-end tests, follow the steps below:
179179
180180
```sh
181181
cp ./.env.example ./.env
182-
cp ./examples/nextjs-test/.env.example ./examples/nextjs-test/.env.local
182+
cp ./references/nextjs-test/.env.example ./references/nextjs-test/.env.local
183183
```
184184
185185
2. Set up dependencies
186186
187187
```sh
188188
# Build packages
189-
pnpm run build --filter @examples/nextjs-test^...
189+
pnpm run build --filter @references/nextjs-test^...
190190
pnpm --filter @trigger.dev/database generate
191191
192192
# Move trigger-cli bin to correct place
@@ -221,11 +221,11 @@ pnpm run db:studio
221221
222222
## Add sample jobs
223223
224-
The [examples/jobs-starter](./examples/jobs-starter/) project defines simple jobs you can get started with.
224+
The [references/job-catalog](./references/job-catalog/) project defines simple jobs you can get started with.
225225
226-
1. `cd` into `examples/jobs-starter`
227-
2. Create a `.env.local` file with the following content,
228-
replacing `[TRIGGER_DEV_API_KEY]` with an actual key:
226+
1. `cd` into `references/job-catalog`
227+
2. Create a `.env` file with the following content,
228+
replacing `<TRIGGER_DEV_API_KEY>` with an actual key:
229229
230230
```env
231231
TRIGGER_API_KEY=[TRIGGER_DEV_API_KEY]
@@ -235,12 +235,20 @@ TRIGGER_API_URL=http://localhost:3030
235235
`TRIGGER_API_URL` is used to configure the URL for your Trigger.dev instance,
236236
where the jobs will be registered.
237237
238-
3. Run the `jobs-starter` app:
238+
3. Run one of the the `job-catalog` files:
239239
240240
```sh
241-
pnpm dev
241+
pnpm run events
242242
```
243243
244+
This will open up a local server using `express` on port 8080. Then in a new terminal window you can run the trigger-cli dev command:
245+
246+
```sh
247+
pnpm run dev:trigger
248+
```
249+
250+
See the [Job Catalog](./references/job-catalog/README.md) file for more.
251+
244252
4. Navigate to your trigger.dev instance ([http://localhost:3030](http://localhost:3030/)), to see the jobs.
245253
You can use the test feature to trigger them.
246254

‎docs/integrations/create-publishing.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "Publishing an official integration package to the public registry.
88
Ensure that you have done the following:
99

1010
- [ ] Create the integrations in the `integrations` folder.
11-
- [ ] Created a file in the `examples/job-catalog` folder with some example jobs.
11+
- [ ] Created a file in the `references/job-catalog` folder with some example jobs.
1212
- [ ] Have exported types.
1313
- [ ] Avoid using `any` types and `@ts-ignore` comments. If there are any, please explain them in the PR.
1414

‎docs/integrations/create-testing.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ title: Testing
33
description: "To test your integration you should create some example Jobs where you test all the functionality."
44
---
55

6-
# examples/job-catalog
6+
# references/job-catalog
77

8-
When building an official integration (in the Trigger.dev monorepo) you should use the job-catalog to test your integration. This collection of examples is useful for creating docs as well as testing.
8+
When building an official integration (in the Trigger.dev monorepo) you should use the job-catalog to test your integration. This collection of reference jobs is useful for creating docs as well as testing.
99

1010
## 1. Getting setup
1111

12-
You can follow [the README](https://github.com/triggerdotdev/trigger.dev/tree/main/examples/job-catalog) to get setup. It explains how to add a new Job as well.
12+
You can follow [the README](https://github.com/triggerdotdev/trigger.dev/tree/main/references/job-catalog) to get setup. It explains how to add a new Job as well.
1313

1414
## 2. Adding your package
1515

16-
You'll need to add your integration to [the package.json file](https://github.com/triggerdotdev/trigger.dev/blob/main/examples/job-catalog/package.json):
16+
You'll need to add your integration to [the package.json file](https://github.com/triggerdotdev/trigger.dev/blob/main/references/job-catalog/package.json):
1717

1818
```json
1919
{
@@ -25,7 +25,7 @@ You'll need to add your integration to [the package.json file](https://github.co
2525
}
2626
```
2727

28-
And to [the tsconfig.json file](https://github.com/triggerdotdev/trigger.dev/blob/main/examples/job-catalog/tsconfig.json):
28+
And to [the tsconfig.json file](https://github.com/triggerdotdev/trigger.dev/blob/main/references/job-catalog/tsconfig.json):
2929

3030
```json
3131
{
@@ -47,4 +47,4 @@ And to [the tsconfig.json file](https://github.com/triggerdotdev/trigger.dev/blo
4747

4848
## 3. Adding your Jobs
4949

50-
Create a new file in `src` that uses all the features of your integration. [The Typeform one](https://github.com/triggerdotdev/trigger.dev/blob/main/examples/job-catalog/src/typeform.ts) is a useful reference that has Tasks and Triggers.
50+
Create a new file in `src` that uses all the features of your integration. [The Typeform one](https://github.com/triggerdotdev/trigger.dev/blob/main/references/job-catalog/src/typeform.ts) is a useful reference that has Tasks and Triggers.

‎examples/jobs-starter/README.md‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎examples/jobs-starter/app/api/trigger/route.ts‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎examples/jobs-starter/app/layout.tsx‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎examples/jobs-starter/app/page.tsx‎

Lines changed: 0 additions & 113 deletions
This file was deleted.

0 commit comments

Comments
 (0)