Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation for Plane Runner, a new secure, sandboxed JavaScript/TypeScript execution engine for automations, has been added. Changes include a sidebar navigation entry in the VitePress config and a comprehensive documentation page covering activation, Scripts/Functions building blocks, sandbox globals, security model, execution limits, and practical examples. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/.vitepress/config.ts (1)
1-1:⚠️ Potential issue | 🔴 CriticalFix formatting issues reported by oxfmt.
The pipeline is failing because
oxfmt --checkdetected formatting issues in this file. Runoxfmt(without--check) to automatically fix the formatting.Run the following to fix:
oxfmt docs/.vitepress/config.ts🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/.vitepress/config.ts` at line 1, Run the code formatter oxfmt to fix the formatting issues detected (specifically around the import statement like `import { readFileSync } from "fs";`), e.g., run oxfmt on the file to apply the changes, verify the import and surrounding file now pass `oxfmt --check`, then stage and commit the reformatted file.
🧹 Nitpick comments (3)
docs/automations/plane-runner.md (3)
252-303: Clarify undefined variable in code example.The example on line 294 uses
otherItemIdwithout defining it. While this is illustrative documentation, users copying the example will encounter an error. Consider adding a comment or defining the variable to make the example more complete.📝 Suggested improvement
// Create a relation +const otherItemId = "some-other-work-item-id"; // ID of the work item to link to await Plane.workItems.relations.create( workspaceSlug, projectId, workItemId, { relation_type: "relates_to", issues: [otherItemId] } );🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/automations/plane-runner.md` around lines 252 - 303, The documentation example uses an undefined variable otherItemId in the Plane.workItems.relations.create call; update the example to either define otherItemId (e.g., const otherItemId = "<existingWorkItemId>") or add an inline comment above that line explaining that otherItemId should be replaced with the ID of an existing work item, so readers copying the snippet won't get a ReferenceError when using Plane.workItems.relations.create.
402-442: Consider clarifying the API response pattern.The example uses
statesResult.results || statesResult(line 416) to handle different response shapes fromPlane.states.list(). This pattern appears in multiple examples. If the API response format is inconsistent, it might be worth documenting why this fallback is necessary, or ensuring the API returns a consistent format.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/automations/plane-runner.md` around lines 402 - 442, The example's fallback "statesResult.results || statesResult" in main when calling Plane.states.list causes ambiguity; update main to normalize the API response explicitly by checking the returned shape (e.g., if Array.isArray(statesResult) use it, otherwise use statesResult.results) or introduce a small helper like normalizeResults used by Plane.states.list callers to always return an array; update references in main (statesResult, states, stateGroupMap) to use the normalized array and add a short comment explaining the normalization so future examples show a consistent, documented pattern.
312-318: Document how ENV variables are securely configured.The documentation mentions using
ENVfor secrets and API keys but doesn't explain how these environment variables are securely stored, configured, or managed within Plane. Adding a brief explanation or link to docs on setting up environment variables would help users handle sensitive data correctly.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/automations/plane-runner.md` around lines 312 - 318, Add a short section after the ENV example explaining how environment variables (ENV) are securely configured and managed in Plane: describe using Plane's secrets/variables feature (or CLI) to set EXTERNAL_API_KEY and SLACK_WEBHOOK without committing them to source, mention that values are stored encrypted and injected at runtime, advise against hardcoding secrets and recommend rotating keys and using least-privilege scopes, and include a brief pointer sentence linking to the Plane docs page on configuring environment/secret variables for full setup instructions.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/automations/plane-runner.md`:
- Line 1: The file docs/automations/plane-runner.md has oxfmt formatting errors;
run the formatter to fix them by executing oxfmt on that file (e.g., run oxfmt
docs/automations/plane-runner.md), review the resulting changes to ensure they
match project style, and commit the updated file so the CI oxfmt --check step
passes.
---
Outside diff comments:
In `@docs/.vitepress/config.ts`:
- Line 1: Run the code formatter oxfmt to fix the formatting issues detected
(specifically around the import statement like `import { readFileSync } from
"fs";`), e.g., run oxfmt on the file to apply the changes, verify the import and
surrounding file now pass `oxfmt --check`, then stage and commit the reformatted
file.
---
Nitpick comments:
In `@docs/automations/plane-runner.md`:
- Around line 252-303: The documentation example uses an undefined variable
otherItemId in the Plane.workItems.relations.create call; update the example to
either define otherItemId (e.g., const otherItemId = "<existingWorkItemId>") or
add an inline comment above that line explaining that otherItemId should be
replaced with the ID of an existing work item, so readers copying the snippet
won't get a ReferenceError when using Plane.workItems.relations.create.
- Around line 402-442: The example's fallback "statesResult.results ||
statesResult" in main when calling Plane.states.list causes ambiguity; update
main to normalize the API response explicitly by checking the returned shape
(e.g., if Array.isArray(statesResult) use it, otherwise use
statesResult.results) or introduce a small helper like normalizeResults used by
Plane.states.list callers to always return an array; update references in main
(statesResult, states, stateGroupMap) to use the normalized array and add a
short comment explaining the normalization so future examples show a consistent,
documented pattern.
- Around line 312-318: Add a short section after the ENV example explaining how
environment variables (ENV) are securely configured and managed in Plane:
describe using Plane's secrets/variables feature (or CLI) to set
EXTERNAL_API_KEY and SLACK_WEBHOOK without committing them to source, mention
that values are stored encrypted and injected at runtime, advise against
hardcoding secrets and recommend rotating keys and using least-privilege scopes,
and include a brief pointer sentence linking to the Plane docs page on
configuring environment/secret variables for full setup instructions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 25ba153e-df4b-41d9-8176-a3ffe3f3dd21
📒 Files selected for processing (2)
docs/.vitepress/config.tsdocs/automations/plane-runner.md
| @@ -0,0 +1,586 @@ | |||
| --- | |||
There was a problem hiding this comment.
Fix formatting issues reported by oxfmt.
The pipeline is failing because oxfmt --check detected formatting issues in this file. Run oxfmt (without --check) to automatically fix the formatting.
Run the following to fix:
oxfmt docs/automations/plane-runner.md🧰 Tools
🪛 GitHub Actions: CI
[error] 1-1: oxfmt --check reported format issues in this file. Run without '--check' to fix.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/automations/plane-runner.md` at line 1, The file
docs/automations/plane-runner.md has oxfmt formatting errors; run the formatter
to fix them by executing oxfmt on that file (e.g., run oxfmt
docs/automations/plane-runner.md), review the resulting changes to ensure they
match project style, and commit the updated file so the CI oxfmt --check step
passes.
1 participant
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit