Skip to content

Conversation

@danciaclara
Copy link
Collaborator

@danciaclara danciaclara commented Dec 15, 2025

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


Note

Adds a Sentry integration guide for self-hosted Plane and updates the Self-hosting Integrations navigation to include and reorder entries.

  • Documentation (Self-hosting):
    • Add new Sentry integration setup guide at self-hosting/govern/integrations/sentry.mdx (custom integration, schema, permissions, webhooks, env vars, restart steps).
    • Update mint.json navigation under Configure → Integrations to include self-hosting/govern/integrations/sentry and 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

    • Added Sentry integration capability for self-hosted instances.
  • Documentation

    • Added comprehensive setup guide for Sentry integration, including configuration steps for Docker and Kubernetes deployments, credential handling, and environment variable setup.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Dec 15, 2025

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

Project Deployment Review Updated (UTC)
developer-docs Error Error Dec 15, 2025 8:46pm

@coderabbitai
Copy link

coderabbitai bot commented Dec 15, 2025

Walkthrough

Navigation structure in mint.json was updated to include a new Sentry integration entry, reordering existing Slack and GitLab integrations within the Integrations pages array. A new documentation file for configuring Sentry integration was added to guide self-hosted Plane deployments.

Changes

Cohort / File(s) Summary
Navigation & Documentation Updates
mint.json, self-hosting/govern/integrations/sentry.mdx
Updated Integrations pages array to reorder entries from ["github", "slack", "gitlab"] to ["github", "gitlab", "sentry", "slack"]. Added comprehensive Sentry integration documentation covering prerequisites, custom/public integration creation, schema configuration, webhook setup, credential handling, Docker/Kubernetes deployment configuration, and activation steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Documentation additions and navigation reordering are straightforward changes
  • No logic modifications or functional complexity
  • Verify documentation accuracy and navigation syntax consistency

Poem

🐰 A Sentry joins the fold today,
New paths to monitor come our way,
Self-hosted dreams now clearer sight,
With logs and alerts shining bright! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Sentry integration' directly and specifically describes the main change—adding Sentry integration support to the documentation and navigation structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch sentry-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

@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: 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 /silo prefix.

The Webhook and Redirect URLs use /silo/api/... while the schema later uses /api/sentry/... paths. If the gateway actually expects the /silo prefix 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 /silo to the schema URIs.


289-306: Align “required” status of SENTRY_INTEGRATION_SLUG with 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 not plane”) so operators don’t wonder whether they can safely omit it.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b3f2961 and 3a73394.

📒 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_on usage, 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_URL explanation 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.

@sriramveeraghanta sriramveeraghanta merged commit 26152fc into preview Dec 16, 2025
4 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the sentry-integration branch December 16, 2025 07:51
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