-
Notifications
You must be signed in to change notification settings - Fork 6
Sentry integration #171
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sentry integration #171
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughNavigation structure in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
self-hosting/govern/integrations/sentry.mdx (3)
25-41: Clarify “Custom” vs “Public” integration wording.You call this a “custom integration (also called a public integration)”. In Sentry’s UI these are distinct labels (“Internal” vs “Public”). To avoid user confusion, consider aligning the wording more closely with what Sentry shows in the current UI (e.g., “Public Integration” only, if that’s what users actually click).
37-44: Double‑check webhook and redirect URLs and/siloprefix.The Webhook and Redirect URLs use
/silo/api/...while the schema later uses/api/sentry/...paths. If the gateway actually expects the/siloprefix only for external callbacks and not for the internal API paths, this is fine, but it’s subtle. It may be worth adding a one‑line note explaining that difference so operators don’t try to add/siloto the schema URIs.
289-306: Align “required” status ofSENTRY_INTEGRATION_SLUGwith earlier examples.Above, you instruct users to set
SENTRY_INTEGRATION_SLUG=plane, but in the reference table it’s marked as “Required: No” with no default. Consider clarifying when it is actually needed (e.g., “Optional; only required if your integration slug is notplane”) so operators don’t wonder whether they can safely omit it.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
mint.json(1 hunks)self-hosting/govern/integrations/sentry.mdx(1 hunks)
⏰ 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
🔇 Additional comments (7)
self-hosting/govern/integrations/sentry.mdx (6)
1-8: Strong, clear introduction and context.Frontmatter and opening context cleanly explain the distinction between Plane Cloud and self‑hosted and set expectations for what the guide covers. No issues from a docs or structure standpoint.
59-215: Schema block looks internally consistent and well‑structured.The JSON schema for issue linking and alert‑rule actions is syntactically consistent, and the field sets (required vs optional,
depends_onusage, URIs) line up logically with the surrounding explanations. I don’t see structural issues that would obviously break Sentry’s integration flow.
226-240: Permissions table is precise and actionable.The mapping of permissions to access levels and the “Why This Matters” column is concrete and gives operators confidence about scope. No functional or clarity issues here.
310-322: Nice coverage of self‑hosted Sentry edge case.The
SENTRY_BASE_URLexplanation and follow‑up note about self‑hosted Sentry make the split‑brain nature (Plane vs Sentry domains) clear. This is exactly the level of specificity operators need.
324-339: Restart instructions are concise and accurate.Docker and Helm restart flows are spelled out clearly and match common operational patterns. Nothing to fix here.
341-346: Verify the external activation link target.The activation step deep‑links to
https://docs.plane.so/integrations/sentry#set-up-sentry-integration. Please confirm that this URL (and anchor) is still valid and points to the intended Plane Cloud Sentry integration page; if the heading text changes, the anchor may break.mint.json (1)
120-126: Navigation update is consistent with new doc path.The new
"self-hosting/govern/integrations/sentry"entry matches the added MDX file path, and the reordered list (GitHub → GitLab → Sentry → Slack) is coherent. JSON structure remains valid.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Adds a Sentry integration guide for self-hosted Plane and updates the Self-hosting Integrations navigation to include and reorder entries.
self-hosting/govern/integrations/sentry.mdx(custom integration, schema, permissions, webhooks, env vars, restart steps).mint.jsonnavigation underConfigure → Integrationsto includeself-hosting/govern/integrations/sentryand reorder entries to: GitHub, GitLab, Sentry, Slack.Written by Cursor Bugbot for commit 3a73394. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.