Chore: rename references to test projects, support self-hosted local deploys on macOS #2061
Conversation
|
WalkthroughThis update removes the entire Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant CLI
participant Docker
participant Webapp
Developer->>CLI: Build/test project in test-projects/
CLI->>Docker: Build image (normalize API URL if on macOS)
Docker->>Webapp: Connect using normalized API URL
Webapp-->>Docker: Serve API (API_ORIGIN preferred over APP_ORIGIN)
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
packages/cli-v3/DEVELOPMENT.md (1)
10-10: Fix path consistency in documentation
The instruction now points to/test-projects, but most docs refer to directories relative to the repo root without a leading slash (e.g.,test-projects). Consider removing the leading slash for consistency..dockerignore (1)
43-43: Clean up stale ignore entry?
test-projectsis now ignored as expected. Since thereferencesdirectory has been removed, consider deleting its entry to keep the.dockerignorefile tidy.CONTRIBUTING.md (2)
164-164: Minor grammatical improvement opportunity.- 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. + 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 pick up changes. Any changes to the files inside the `v3-catalog/src/trigger` dir will automatically be rebuilt by the `dev` command.🧰 Tools
🪛 LanguageTool
[uncategorized] ~164-~164: Possible missing article found.
Context: ...devcommand and restart it to pickup changes. Any changes to the files inside of the...(AI_HYDRA_LEO_MISSING_THE)
[style] ~164-~164: This phrase is redundant. Consider using “inside”.
Context: ...ickup changes. Any changes to the files inside of thev3-catalog/src/triggerdir will a...(OUTSIDE_OF)
166-166: Consider adding a comma in compound sentence.- 7. Navigate to the `v3-catalog` project in your local dashboard at localhost:3030 and you should see the list of tasks. + 7. Navigate to the `v3-catalog` project in your local dashboard at localhost:3030, and you should see the list of tasks.🧰 Tools
🪛 LanguageTool
[uncategorized] ~166-~166: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n your local dashboard at localhost:3030 and you should see the list of tasks. 8. G...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (16)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yamlreferences/d3-openai-agents/public/file.svgis excluded by!**/*.svgreferences/d3-openai-agents/public/globe.svgis excluded by!**/*.svgreferences/d3-openai-agents/public/next.svgis excluded by!**/*.svgreferences/d3-openai-agents/public/vercel.svgis excluded by!**/*.svgreferences/d3-openai-agents/public/window.svgis excluded by!**/*.svgreferences/nextjs-realtime/src/app/favicon.icois excluded by!**/*.icotest-projects/d3-chat/public/file.svgis excluded by!**/*.svgtest-projects/d3-chat/public/globe.svgis excluded by!**/*.svgtest-projects/d3-chat/public/next.svgis excluded by!**/*.svgtest-projects/d3-chat/public/vercel.svgis excluded by!**/*.svgtest-projects/d3-chat/public/window.svgis excluded by!**/*.svgtest-projects/d3-chat/src/app/favicon.icois excluded by!**/*.icotest-projects/nextjs-realtime/src/app/favicon.icois excluded by!**/*.icotest-projects/nextjs-realtime/src/app/fonts/GeistMonoVF.woffis excluded by!**/*.wofftest-projects/nextjs-realtime/src/app/fonts/GeistVF.woffis excluded by!**/*.woff
📒 Files selected for processing (49)
.dockerignore(1 hunks)CONTRIBUTING.md(9 hunks)ai/references/repo.md(1 hunks)apps/supervisor/README.md(1 hunks)apps/webapp/app/routes/api.v1.projects.$projectRef.$env.ts(1 hunks)packages/cli-v3/DEVELOPMENT.md(1 hunks)packages/cli-v3/src/deploy/buildImage.ts(2 hunks)pnpm-workspace.yaml(1 hunks)references/bun-catalog/.env.example(0 hunks)references/bun-catalog/package.json(0 hunks)references/bun-catalog/src/trigger/bun.ts(0 hunks)references/bun-catalog/trigger.config.ts(0 hunks)references/d3-openai-agents/.gitignore(0 hunks)references/d3-openai-agents/components.json(0 hunks)references/d3-openai-agents/next.config.ts(0 hunks)references/d3-openai-agents/package.json(0 hunks)references/d3-openai-agents/postcss.config.mjs(0 hunks)references/d3-openai-agents/requirements.in(0 hunks)references/d3-openai-agents/requirements.txt(0 hunks)references/d3-openai-agents/src/app/api/slack/interaction/route.ts(0 hunks)references/d3-openai-agents/src/app/globals.css(0 hunks)references/d3-openai-agents/src/app/layout.tsx(0 hunks)references/d3-openai-agents/src/app/page.tsx(0 hunks)references/d3-openai-agents/src/components/chat-interface.tsx(0 hunks)references/d3-openai-agents/src/components/initial-prompt.tsx(0 hunks)references/d3-openai-agents/src/components/main-app.tsx(0 hunks)references/d3-openai-agents/src/extensions/playwright.ts(0 hunks)references/d3-openai-agents/src/lib/migrate.ts(0 hunks)references/d3-openai-agents/src/trigger/approval.ts(0 hunks)references/d3-openai-agents/src/trigger/chat.ts(0 hunks)references/d3-openai-agents/src/trigger/openaiAgent.ts(0 hunks)references/d3-openai-agents/src/trigger/python/agent.py(0 hunks)references/d3-openai-agents/src/trigger/schemas.ts(0 hunks)references/d3-openai-agents/tailwind.config.ts(0 hunks)references/d3-openai-agents/trigger.config.ts(0 hunks)references/d3-openai-agents/tsconfig.json(0 hunks)references/nextjs-realtime/README.md(0 hunks)references/nextjs-realtime/src/lib/utils.ts(0 hunks)references/python-catalog/tsconfig.json(0 hunks)references/test-tasks/package.json(0 hunks)references/test-tasks/src/trigger/helpers.ts(0 hunks)references/test-tasks/src/trigger/test-heartbeats.ts(0 hunks)references/test-tasks/src/trigger/test-reserve-concurrency-system.ts(0 hunks)references/test-tasks/src/utils.ts(0 hunks)references/test-tasks/trigger.config.ts(0 hunks)references/test-tasks/tsconfig.json(0 hunks)references/v3-catalog/.gitignore(0 hunks)references/v3-catalog/README.md(0 hunks)test-projects/README.md(3 hunks)
💤 Files with no reviewable changes (40)
- references/v3-catalog/.gitignore
- references/nextjs-realtime/README.md
- references/d3-openai-agents/trigger.config.ts
- references/d3-openai-agents/requirements.in
- references/nextjs-realtime/src/lib/utils.ts
- references/d3-openai-agents/components.json
- references/v3-catalog/README.md
- references/d3-openai-agents/src/components/initial-prompt.tsx
- references/d3-openai-agents/tsconfig.json
- references/d3-openai-agents/src/app/page.tsx
- references/bun-catalog/.env.example
- references/test-tasks/tsconfig.json
- references/d3-openai-agents/src/extensions/playwright.ts
- references/test-tasks/package.json
- references/d3-openai-agents/tailwind.config.ts
- references/test-tasks/trigger.config.ts
- references/bun-catalog/src/trigger/bun.ts
- references/d3-openai-agents/src/app/layout.tsx
- references/d3-openai-agents/src/components/chat-interface.tsx
- references/d3-openai-agents/next.config.ts
- references/d3-openai-agents/src/trigger/schemas.ts
- references/d3-openai-agents/requirements.txt
- references/python-catalog/tsconfig.json
- references/d3-openai-agents/postcss.config.mjs
- references/d3-openai-agents/src/trigger/chat.ts
- references/d3-openai-agents/.gitignore
- references/bun-catalog/trigger.config.ts
- references/bun-catalog/package.json
- references/d3-openai-agents/src/lib/migrate.ts
- references/test-tasks/src/utils.ts
- references/test-tasks/src/trigger/test-heartbeats.ts
- references/d3-openai-agents/src/app/api/slack/interaction/route.ts
- references/d3-openai-agents/src/app/globals.css
- references/d3-openai-agents/src/trigger/openaiAgent.ts
- references/test-tasks/src/trigger/test-reserve-concurrency-system.ts
- references/d3-openai-agents/src/components/main-app.tsx
- references/d3-openai-agents/src/trigger/python/agent.py
- references/d3-openai-agents/package.json
- references/d3-openai-agents/src/trigger/approval.ts
- references/test-tasks/src/trigger/helpers.ts
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
69-69: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~164-~164: Possible missing article found.
Context: ... dev command and restart it to pickup changes. Any changes to the files inside of the...
(AI_HYDRA_LEO_MISSING_THE)
[style] ~164-~164: This phrase is redundant. Consider using “inside”.
Context: ...ickup changes. Any changes to the files inside of the v3-catalog/src/trigger dir will a...
(OUTSIDE_OF)
[uncategorized] ~166-~166: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n your local dashboard at localhost:3030 and you should see the list of tasks. 8. G...
(COMMA_COMPOUND_SENTENCE)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: units / 🧪 Unit Tests
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (12)
pnpm-workspace.yaml (1)
5-5: Workspace inclusion updated for renamed directory
The new entry- "test-projects/*"correctly replaces the oldreferences/*workspace pattern. Verify there are no remainingreferences/*entries in other workspace configs to avoid stray inclusions.apps/supervisor/README.md (1)
39-39: Terminology updated from reference to test project
Accurately replaces “reference project” with “test project” to reflect the renamed directory.ai/references/repo.md (1)
30-30: Documentation path updated for test workspaces
The path<root>/test-projects/*now correctly replaces the previous references directory in this overview.apps/webapp/app/routes/api.v1.projects.$projectRef.$env.ts (1)
91-91: Good change preferring API_ORIGIN over APP_ORIGIN.This change appropriately prefers the more specific
API_ORIGINenvironment variable when available, while maintaining the fallback toAPP_ORIGIN. This aligns with the Docker support for macOS implementation inbuildImage.ts.test-projects/README.md (3)
56-57: Improved clarity about HTTP tunnel requirements.The updated formatting and clarification that this step is optional makes the setup instructions more user-friendly.
64-65: Better placeholder identification in examples.Explicitly calling out placeholders that need to be replaced (
<your-auth-token>,<your-app-port>) makes the instructions more accessible, especially for new contributors.Also applies to: 72-77
104-104: Updated path reference from references to test-projects.Correctly updated the path for copying the hello-world template to reflect the new directory structure.
packages/cli-v3/src/deploy/buildImage.ts (2)
330-330: Good update to normalize the API URL for Docker builds.Using the helper function here ensures proper API connectivity when running in Docker containers, especially on macOS.
727-735: Excellent solution for macOS Docker networking.This helper function correctly handles the platform-specific case for macOS, where Docker containers need to access the host using
host.docker.internalinstead oflocalhost. The implementation is clean and well-commented.CONTRIBUTING.md (3)
70-70: Expanded build instructions to cover more packages.The updated build command now includes both webapp and SDK packages, which provides a more complete development setup.
109-113: Successfully updated references/v3-catalog to test-projects/v3-catalog.All directory references and commands have been correctly updated to use the new test-projects path.
Also applies to: 122-126, 153-154, 160-161
180-180: Consistent updates to all test project references.All remaining references to the old directory structure have been updated properly, ensuring documentation consistency.
Also applies to: 187-187, 251-251, 253-253, 277-277
Summary by CodeRabbit
test-projectsdirectory instead ofreferences, improving clarity and accuracy in setup and usage instructions.test-projectsdirectory from Docker build context for cleaner builds.test-projectsinstead of deprecated references.