Skip to content

Conversation

AbhiPrasad
Copy link
Member

@AbhiPrasad AbhiPrasad commented Sep 18, 2025

Documents getsentry/sentry-electron#1234

DESCRIBE YOUR PR

This PR documents the ipcNamespace option for the Sentry Electron SDK. This option allows users to specify a custom namespace for Sentry's IPC channels, preventing potential conflicts in applications that use multiple IPC channels.

The documentation has been added to:

  • The main Electron guide (docs/platforms/javascript/guides/electron/index.mdx) with a new "Custom IPC Namespace" subsection.
  • The common configuration options page (docs/platforms/javascript/common/configuration/options.mdx) with a detailed SdkOption entry.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES


Slack Thread

Open in Cursor Open in Web

Copy link

cursor bot commented Sep 18, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

Copy link

vercel bot commented Sep 18, 2025

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

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Sep 18, 2025 5:30pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Preview Sep 18, 2025 5:30pm

Copy link

codecov bot commented Sep 18, 2025

Bundle Report

Changes will increase total bundle size by 936 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.91MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.65MB 942 bytes (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/bxXkVnwgvDrM8PpFjkkpV/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/bxXkVnwgvDrM8PpFjkkpV/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/5slu55XkJlCfiSh2L2S2D/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/5slu55XkJlCfiSh2L2S2D/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json 317 bytes 819.48kB 0.04%
../app/platform-redirect/page.js.nft.json 317 bytes 819.39kB 0.04%
../app/sitemap.xml/route.js.nft.json 317 bytes 816.87kB 0.04%

@AbhiPrasad AbhiPrasad self-assigned this Sep 18, 2025
@AbhiPrasad AbhiPrasad marked this pull request as ready for review September 18, 2025 17:03
@AbhiPrasad AbhiPrasad requested review from a team, chargome, s1gr1d and timfish and removed request for a team September 18, 2025 17:03
@AbhiPrasad AbhiPrasad merged commit c2ab389 into master Sep 18, 2025
13 checks passed
@AbhiPrasad AbhiPrasad deleted the cursor/document-ipcnamespace-option-for-sentry-electron-32c1 branch September 18, 2025 17:53
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