|
1 |
| -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
2 | 1 |
|
3 |
| -## Getting Started |
| 2 | +## Vercel Actions Example for octomind-integration |
4 | 3 |
|
5 |
| -First, run the development server: |
| 4 | +This project is supposed to showcase the way to integrate [octomind](https://octomind.dev) into a vercel-deployed app. |
6 | 5 |
|
7 |
| -```bash |
8 |
| -npm run dev |
9 |
| -# or |
10 |
| -yarn dev |
11 |
| -# or |
12 |
| -pnpm dev |
| 6 | +This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
| 7 | +Deployment happens on [Vercel](https://vercel.com) with the native vercel-github integration. |
| 8 | + |
| 9 | +The octomind tests use the [octomind execute action](https://github.com/OctoMind-dev/automagically-action-execute) and the [octomind github app](https://github.com/apps/octomind-dev) |
| 10 | +to enable running tests on each preview branch. See the [.github/workflows/octomind.yml](.github/workflows/octomind.yml) file for the actions integration or just copy it: |
| 11 | + |
| 12 | +```yml |
| 13 | +on: |
| 14 | + deployment_status |
| 15 | + |
| 16 | +concurrency: |
| 17 | + group: ${{ github.workflow }}-${{ github.ref }} |
| 18 | + cancel-in-progress: true |
| 19 | + |
| 20 | +jobs: |
| 21 | + octomind: |
| 22 | + if: ${{ github.event.deployment_status.state == 'success' }} |
| 23 | + name: 🚀🐙 trigger octomind e2e tests 🚀🐙 |
| 24 | + runs-on: ubuntu-latest |
| 25 | + steps: |
| 26 | + - uses: OctoMind-dev/automagically-action-execute@v2 |
| 27 | + with: |
| 28 | + testTargetId: <yourTestTargetId> |
| 29 | + url: ${{ github.event.deployment_status.target_url }} |
| 30 | + token: ${{ secrets.AUTOMAGICALLY_TOKEN }} |
13 | 31 | ```
|
14 | 32 |
|
15 |
| -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
16 |
| - |
17 |
| -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
18 |
| - |
19 |
| -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. |
20 |
| - |
21 |
| -## Learn More |
22 |
| - |
23 |
| -To learn more about Next.js, take a look at the following resources: |
24 |
| - |
25 |
| -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
26 |
| -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
27 |
| - |
28 |
| -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! |
29 |
| - |
30 |
| -## Deploy on Vercel |
| 33 | +See [🚀🐙 trigger octomind e2e tests 🚀🐙](https://github.com/OctoMind-dev/vercel-actions-example/actions/runs/5613582651/job/15209923666?pr=1) for a successful actions run after a vercel deployment. |
31 | 34 |
|
32 |
| -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 35 | +Follow the setup workflow as described in our [docs](https://docs.octomind.dev/quickstart-vercel) to get the required data. |
33 | 36 |
|
34 |
| -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |
|
0 commit comments