Skip to content

Cursor integration#459

Open
danciaclara wants to merge 4 commits into
masterfrom
cursor-integration
Open

Cursor integration#459
danciaclara wants to merge 4 commits into
masterfrom
cursor-integration

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Jun 4, 2026

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Expanded custom automations documentation to include Send webhook action, enhanced Add comment guidance with template variables, clarified automation workflow and event processing, and expanded common use cases.
    • Published Cursor integration guide covering setup, authentication options (shared key and per-user modes), and usage instructions for generating code and opening pull requests from work items.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 4, 2026 4:10pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

Warning

Review limit reached

@danciaclara, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 50 minutes and 38 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3f2ad9f9-feb7-4c04-8bca-20f1358a803e

📥 Commits

Reviewing files that changed from the base of the PR and between a083005 and 8edcc84.

📒 Files selected for processing (1)
  • docs/integrations/cursor.md
📝 Walkthrough

Walkthrough

This PR updates documentation across two features: it enhances the custom automations guide with Send webhook action support, refined setup workflows, and expanded conceptual explanations; and it introduces comprehensive Cursor integration documentation covering workspace setup, authentication modes, member account management, and usage patterns for converting work items to code-generating specs.

Changes

Custom Automations Enhancement

Layer / File(s) Summary
Setup workflow refinements
docs/automations/custom-automations.md
Early automation setup steps refined for project and workspace automations, constraint added that enabled automations must be disabled before deletion.
Send webhook action introduction
docs/automations/custom-automations.md
Send webhook added to available action types in action chooser, AND logic for conditions documented.
Send webhook detailed reference
docs/automations/custom-automations.md
Comprehensive webhook action documentation: configuration fields, secret key lifecycle, Plane request headers, HMAC-SHA256 payload verification with code example, delivery behavior and retries.
Automation execution and scope concepts
docs/automations/custom-automations.md
Expanded explanation of trigger→conditions→actions flow, single event processing, project vs. workspace scope, Automation Bot attribution, why triggers require conditions, and why scheduled automations only support Run script action.

Cursor Integration Documentation

Layer / File(s) Summary
Integration overview
docs/integrations/cursor.md
New documentation introducing Cursor integration: converting work items to Cursor specs for code generation and GitHub PR creation, with prerequisites.
Admin setup and configuration
docs/integrations/cursor.md
Workspace admin installation, Cursor API key configuration with encryption, and project-to-repository mapping management (create, edit, delete).
Authentication modes and PR behavior
docs/integrations/cursor.md
Shared-key vs per-user authentication modes, PR creation and billing behavior differences, switching mode instructions and effects.
Member account management
docs/integrations/cursor.md
Per-user mode member instructions: connect/disconnect personal Cursor accounts, what Plane displays, and effects of removal.
Usage patterns and best practices
docs/integrations/cursor.md
Triggering Cursor via assignee or @cursor comments, selecting repositories with [repo=owner/name], and guidance for writing effective Cursor instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • makeplane/docs#458: The expanded Send webhook action section and revised automations flow directly overlap with the same custom automations file changes.

Suggested reviewers

  • sriramveeraghanta

Poem

🐰 A webhook whispers, Cursor takes flight,
New automations flow, sparkling bright,
Docs dance with details, configs align,
Integration magic, feature design!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Cursor integration' is partially related to the changeset. While it accurately reflects the new Cursor integration documentation added, it does not capture the significant updates to custom automations documentation, which represents roughly one-third of the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor-integration

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/automations/custom-automations.md`:
- Around line 176-178: The fenced code block in the custom automations example
lacks a language identifier; update the snippet that currently starts with ```
to specify a language such as ```text (or ```markdown) so it becomes ```text
followed by the example line "This item has been moved..." and the closing ```;
apply this change in docs/automations/custom-automations.md for the example
comment template and re-run formatting (pnpm check:format) to ensure it meets
GitHub-flavored Markdown requirements.

In `@docs/integrations/cursor.md`:
- Around line 166-168: The fenced code block containing the line starting with
"`@cursor` Fix the null pointer exception in the auth module [repo=acme/backend]"
needs a language identifier to satisfy markdownlint MD040; update that block in
docs/integrations/cursor.md to use a language like "text" or "plaintext" (e.g.,
change ``` to ```text), then run pnpm fix:format and confirm formatting with
pnpm check:format before committing.
- Around line 145-150: The fenced code block containing the repository hint
"[repo=acme/backend]" is missing a language identifier (MD040); update the block
to include a language like `text` or `plaintext` (e.g., change ``` to ```text)
so markdownlint passes, then run the project's formatter/format check (pnpm
fix:format and pnpm check:format) before committing to ensure CI format checks
succeed.
🪄 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: ea75c2ce-e09b-49df-93b1-c2329f8c92bf

📥 Commits

Reviewing files that changed from the base of the PR and between 147fe5f and a083005.

📒 Files selected for processing (2)
  • docs/automations/custom-automations.md
  • docs/integrations/cursor.md

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/automations/custom-automations.md`:
- Around line 176-178: The fenced code block in the custom automations example
lacks a language identifier; update the snippet that currently starts with ```
to specify a language such as ```text (or ```markdown) so it becomes ```text
followed by the example line "This item has been moved..." and the closing ```;
apply this change in docs/automations/custom-automations.md for the example
comment template and re-run formatting (pnpm check:format) to ensure it meets
GitHub-flavored Markdown requirements.

In `@docs/integrations/cursor.md`:
- Around line 166-168: The fenced code block containing the line starting with
"`@cursor` Fix the null pointer exception in the auth module [repo=acme/backend]"
needs a language identifier to satisfy markdownlint MD040; update that block in
docs/integrations/cursor.md to use a language like "text" or "plaintext" (e.g.,
change ``` to ```text), then run pnpm fix:format and confirm formatting with
pnpm check:format before committing.
- Around line 145-150: The fenced code block containing the repository hint
"[repo=acme/backend]" is missing a language identifier (MD040); update the block
to include a language like `text` or `plaintext` (e.g., change ``` to ```text)
so markdownlint passes, then run the project's formatter/format check (pnpm
fix:format and pnpm check:format) before committing to ensure CI format checks
succeed.
🪄 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: ea75c2ce-e09b-49df-93b1-c2329f8c92bf

📥 Commits

Reviewing files that changed from the base of the PR and between 147fe5f and a083005.

📒 Files selected for processing (2)
  • docs/automations/custom-automations.md
  • docs/integrations/cursor.md
🛑 Comments failed to post (3)
docs/automations/custom-automations.md (1)

176-178: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Specify language for the fenced code block.

The example comment template should have a language specified for the fenced code block. Since this is example text content (not executable code), consider using text or markdown as the language identifier.

📝 Proposed fix
-```
+```text
 This item has been moved to a new state. Current priority: {{priority}}. Please check if the due date needs updating.
</details>

As per coding guidelines, all content files must use GitHub-flavored Markdown syntax with proper formatting enforced via pnpm check:format.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>

[warning] 176-176: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docs/automations/custom-automations.md around lines 176 - 178, The fenced
code block in the custom automations example lacks a language identifier; update
the snippet that currently starts with to specify a language such astext
(or markdown) so it becomes text followed by the example line "This item
has been moved..." and the closing ```; apply this change in
docs/automations/custom-automations.md for the example comment template and
re-run formatting (pnpm check:format) to ensure it meets GitHub-flavored
Markdown requirements.


</details>

<!-- fingerprinting:phantom:triton:puma -->

<!-- This is an auto-generated comment by CodeRabbit -->

</blockquote></details>
<details>
<summary>docs/integrations/cursor.md (2)</summary><blockquote>

145-150: _⚠️ Potential issue_ | _🟡 Minor_ | _⚡ Quick win_

**Add language identifier to fenced code block.**

The fenced code block is missing a language specification, which violates the markdownlint MD040 rule. Even though this is configuration syntax rather than programming code, please add a language identifier such as `text` or `plaintext`.



<details>
<summary>📝 Proposed fix</summary>

```diff
-```
+```text
 [repo=acme/backend]
 ```
```
</details>

As per coding guidelines: "Run pnpm fix:format before committing and ensure CI check via pnpm check:format passes; formatting is enforced."

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion
If your project is mapped to more than one GitHub repository, Cursor needs to know which one to use. Add a comment with `[repo=owner/name]` after assigning:

```

</details>

<!-- suggestion_end -->

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>

[warning] 147-147: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docs/integrations/cursor.md around lines 145 - 150, The fenced code block
containing the repository hint "[repo=acme/backend]" is missing a language
identifier (MD040); update the block to include a language like text or
plaintext (e.g., change totext) so markdownlint passes, then run the
project's formatter/format check (pnpm fix:format and pnpm check:format) before
committing to ensure CI format checks succeed.


</details>

<!-- fingerprinting:phantom:triton:puma -->

<!-- This is an auto-generated comment by CodeRabbit -->

---

166-168: _⚠️ Potential issue_ | _🟡 Minor_ | _⚡ Quick win_

**Add language identifier to fenced code block.**

The fenced code block is missing a language specification, which violates the markdownlint MD040 rule. Please add a language identifier such as `text` or `plaintext`.



<details>
<summary>📝 Proposed fix</summary>

```diff
-```
+```text
 `@cursor` Fix the null pointer exception in the auth module [repo=acme/backend]
 ```
```
</details>

As per coding guidelines: "Run pnpm fix:format before committing and ensure CI check via pnpm check:format passes; formatting is enforced."

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>

[warning] 166-166: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docs/integrations/cursor.md around lines 166 - 168, The fenced code block
containing the line starting with "@cursor Fix the null pointer exception in the
auth module [repo=acme/backend]" needs a language identifier to satisfy
markdownlint MD040; update that block in docs/integrations/cursor.md to use a
language like "text" or "plaintext" (e.g., change totext), then run pnpm
fix:format and confirm formatting with pnpm check:format before committing.


</details>

<!-- fingerprinting:phantom:triton:puma -->

<!-- This is an auto-generated comment by CodeRabbit -->

</blockquote></details>

</blockquote></details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants