Skip to content

docs(unity): Fix debug symbol upload docs - #20418

Open
bitsandfoxes wants to merge 6 commits into
masterfrom
fix/unity-docs-debug-symbols
Open

bitsandfoxes wants to merge 6 commits into
masterfrom
fix/unity-docs-debug-symbols

Conversation

@bitsandfoxes

@bitsandfoxes bitsandfoxes commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Corrects the Unity debug symbol upload docs against the sentry-unity 4.13.0 source: where the settings are, where and when the upload runs on each platform, how to keep the auth token safe, and how to upload by hand.

Stacked on #20416 (native support and platforms). Its base is that branch, so the diff shows only this PR's changes.

  • Native Support, Debug Symbols:
    • The settings are on the Debug Symbols tab (Tools > Sentry); Auth Token and Project Name are required, Org Slug is optional.
    • A table of where the upload runs per platform (Unity Editor after the build for desktop and consoles, the Gradle build on Android, an Xcode build phase on iOS, none on WebGL), its conditions and where its log goes, plus how exported Gradle and Xcode projects upload.
    • A warning that exported Xcode and Gradle projects contain sentry.properties with the auth token in plain text.
    • The iOS section describes the Xcode build phase; a new Android section covers ProGuard/R8.
    • The manual sentry-cli command includes --il2cpp-mapping, names the folders to upload, and lists the SDK package folders that hold the Sentry native SDK's own symbols and the extra console paths.
  • CLI options: defaults for the four switches, Org Slug optional, UrlOverride explained, "debug files" instead of "sourcemaps", the SentryCliOptionsConfiguration class and CLI Config Script field, and a CI sample that reads SENTRY_AUTH_TOKEN only in batch mode. A new screenshot of the Debug Symbols tab.
  • IL2CPP: C# line numbers on Windows, macOS, Linux, Android, iOS, Xbox and PlayStation 5, not on WebGL or Nintendo Switch; release builds by default and development builds with Upload Dev Symbols; the IL2CPP and linker arguments the SDK adds to the project.
  • Debug files: the upload page shows the Unity command instead of the .NET NuGet/MSBuild section; source context points to Upload Sources; the file-formats page explains IL2CPP line mappings and Burst debug information.
  • Troubleshooting: a "Debug Symbol Upload" checklist and what Ignore CLI Errors does.

Pages to check on the preview:

  • /platforms/unity/native-support/#debug-symbols
  • /platforms/unity/configuration/options/cli-options/
  • /platforms/unity/configuration/il2cpp/
  • /platforms/unity/data-management/debug-files/upload/
  • /platforms/unity/troubleshooting/

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

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

🤖 Generated with Claude Code

@vercel

vercel Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Nov 13, 2026 11:01pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 13, 2026 11:01pm UTC

Request Review

@coolguyzone coolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@JoshuaMoelans JoshuaMoelans left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm, small nit on wording (there's similar wording about --include-sources in one of the other files already)

Describe where the debug symbol upload runs on each platform, which
settings it needs, and where to find its logs. Point to the Debug
Symbols tab, mark Org Slug as optional, and add option defaults.

Add a SentryCliOptionsConfiguration sample that reads the auth token
from an environment variable, and warn that exported Xcode and Gradle
projects contain sentry.properties with the token in plain text.

Replace .NET-specific text on the upload and source context pages
with the Unity workflow, add a Unity debug-files include, and document
IL2CPP line mappings and Burst debug information. Update the IL2CPP
platform list and the screenshot of the Debug Symbols tab.
bitsandfoxes and others added 5 commits November 13, 2026 23:56
Set secrets in the CLI options sample only in batch mode, since values
set in Configure can be saved to SentryCliOptions.asset. Keep the
upload log locations in the native support table only, and list the
upload conditions there.

Scope the manual upload to desktop and console builds and name the
Sentry native SDK symbols that the build folder doesn't contain.
Describe where the iOS upload output goes with Ignore CLI Errors, and
trim the Unity debug-files include.
Co-authored-by: JoshuaMoelans <60878493+JoshuaMoelans@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 1a235eb8 Deployed Nov 13, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants