Skip to content
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

feat: Godot debug symbols guide #12843

Merged
merged 13 commits into from
Mar 8, 2025
Merged

feat: Godot debug symbols guide #12843

merged 13 commits into from
Mar 8, 2025

Conversation

limbonaut
Copy link
Collaborator

@limbonaut limbonaut commented Feb 25, 2025

DESCRIBE YOUR PR

Add a guide on how to get readable stack traces with SDK for Godot Engine.

I've tested these instructions on Windows and Arch Linux, successfully getting traces symbolicated for crashes.

image

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • 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

Copy link

vercel bot commented Feb 25, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 8, 2025 0:58am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Mar 8, 2025 0:58am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Mar 8, 2025 0:58am

Copy link

codecov bot commented Feb 25, 2025

Bundle Report

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

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

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.46MB -0.0%
../instrumentation.js -3 bytes 791.26kB -0.0%
9523.js -3 bytes 767.46kB -0.0%
../app/[[...path]]/page.js.nft.json 221 bytes 382.43kB 0.06%
../app/platform-redirect/page.js.nft.json 221 bytes 382.34kB 0.06%
../app/sitemap.xml/route.js.nft.json 221 bytes 380.31kB 0.06%
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 868.04kB -0.0%
static/chunks/4028-*.js -3 bytes 393.29kB -0.0%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.55kB 1.0kB -84.74%
static/f-*.js (New) 77 bytes 77 bytes 100.0% 🚀
static/f-*.js (New) 578 bytes 578 bytes 100.0% 🚀
static/g09E45dBITiIaXrDJ_oBQ/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/g09E45dBITiIaXrDJ_oBQ/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

@limbonaut limbonaut marked this pull request as ready for review February 26, 2025 12:28

<Alert>

Learn more about debug formats in [Debug Information Files](/platforms/native/data-management/debug-files/).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Linking to Native page, as it's more likely to stay up-to-date on this topic.

Copy link
Member

Choose a reason for hiding this comment

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

Not sure this is what we should be doing, but I do agree it's annoying things can get out of sync since we're duplicating all docs now. @coolguyzone thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

perhaps for that general debug file info we shoujld add to an include and reuse it everywhere.
That's the same in all docs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's still unclear to me what is the consensus on this.


<Alert>

Learn more about debug formats in [Debug Information Files](/platforms/native/data-management/debug-files/).
Copy link
Member

Choose a reason for hiding this comment

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

Not sure this is what we should be doing, but I do agree it's annoying things can get out of sync since we're duplicating all docs now. @coolguyzone thoughts?


<Alert>

Learn more about debug formats in [Debug Information Files](/platforms/native/data-management/debug-files/).
Copy link
Member

Choose a reason for hiding this comment

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

perhaps for that general debug file info we shoujld add to an include and reuse it everywhere.
That's the same in all docs

@bruno-garcia
Copy link
Member

@andreiborza if by any chance you're looking for readable stack traces and you'd wanna try this out and give feedback (or a review) that'll be much appreciated

@bruno-garcia
Copy link
Member

This is looking great. A few things we can follow up on but lets get that shipped to start!

@bruno-garcia bruno-garcia enabled auto-merge (squash) March 8, 2025 00:46
@bruno-garcia bruno-garcia merged commit daa91f5 into master Mar 8, 2025
11 checks passed
@bruno-garcia bruno-garcia deleted the feat/godot-debug-symbols branch March 8, 2025 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants