Updated Slack integration #386
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocs for the Slack integration ( Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant User
participant SlackClient as Slack
participant PlaneAPI as Plane
participant DB as Database
Note over User,SlackClient: User triggers "Create work item" via Slack modal
User->>SlackClient: open message shortcut / slash command
SlackClient->>PlaneAPI: fetch modal schema & projects
PlaneAPI->>DB: query user's projects & permissions
DB-->>PlaneAPI: return projects
PlaneAPI-->>SlackClient: modal payload (Project, Add as, Work Item Type)
SlackClient-->>User: render modal
User->>SlackClient: submit modal with details
SlackClient->>PlaneAPI: create work item payload
PlaneAPI->>DB: persist work item
DB-->>PlaneAPI: confirm creation
PlaneAPI-->>SlackClient: success response + link/quick actions
SlackClient-->>User: post confirmation & quick action buttons
Note right of PlaneAPI: If user mentions `@Plane` (AI agent), PlaneAPI calls AI service and returns suggestions/edits
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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. 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
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/integrations/slack.mdx
🧰 Additional context used
🪛 LanguageTool
docs/integrations/slack.mdx
[grammar] ~124-~124: Ensure spelling is correct
Context: ... or thread. 2. Click the three-dot menu adn select Link Work Item. . +Only one Workspace Admin can connect their personal Slack account via Workspace Settings. Other Admins and Members can connect theirs from [Profile settings](/integrations/slack#from-profile-settings).
227-227: Fix terminology inconsistency.Use "Work Items" instead of "Issues" to maintain consistent terminology throughout the documentation.
🔎 Proposed fix
-- **Issues** +- **Work Items** Title, status, priority, assignee, and quick actions.
♻️ Duplicate comments (1)
docs/integrations/slack.mdx (1)
83-83: Remove redundant sentence and fix terminology inconsistency.This sentence is redundant with the introduction on lines 81-82 and uses "issues" instead of the consistent "work items" terminology used throughout the document.
🔎 Proposed fix
-There are two easy ways to create issues from Slack, depending on your workflow: using the message shortcut or the `/plane` command. Any updates in Plane to fields like State, Assignee, or others will automatically reflect in the linked Slack thread. +Any updates in Plane to fields like State, Assignee, or others will automatically reflect in the linked Slack thread.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/integrations/slack.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
| 5. Select a Plane Project and the corresponding Slack Channel you’d like to connect. | ||
| 6. Click Save. | ||
|
|
||
| Once set, Plane will automatically post updates to the selected Slack channel every time a new work item is created in that project keeping your team informed and your workflows connected. |
There was a problem hiding this comment.
Add missing punctuation for clarity.
The sentence is missing punctuation between clauses. Add a comma or dash before "keeping your team informed" to improve readability.
🔎 Proposed fix
-Once set, Plane will automatically post updates to the selected Slack channel every time a new work item is created in that project keeping your team informed and your workflows connected.
+Once set, Plane will automatically post updates to the selected Slack channel every time a new work item is created in that project, keeping your team informed and your workflows connected.📝 Committable suggestion
‼️ 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.
| Once set, Plane will automatically post updates to the selected Slack channel every time a new work item is created in that project keeping your team informed and your workflows connected. | |
| Once set, Plane will automatically post updates to the selected Slack channel every time a new work item is created in that project, keeping your team informed and your workflows connected. |
🤖 Prompt for AI Agents
In docs/integrations/slack.mdx around line 169, the sentence "Once set, Plane
will automatically post updates to the selected Slack channel every time a new
work item is created in that project keeping your team informed and your
workflows connected." is missing punctuation before the clause "keeping your
team informed"; insert a comma (or a dash) after "project" so it reads
"...created in that project, keeping your team informed and your workflows
connected." to improve clarity and readability.
Note
Major overhaul of
docs/integrations/slack.mdxto modernize the Slack integration guide with new flows, images, and features./plane) with modal options (Project,Add as,Work Item Type) and Thread Sync details@Planefor creating items, project info, cycle status)Privacy and permissionsWritten by Cursor Bugbot for commit 057ca8c. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.