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

Package windows symbols with actions builds #2068

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

hspir404
Copy link
Contributor

@hspir404 hspir404 commented Jan 5, 2025

This commit packages up the symbol files (for Windows builds), so it is possible to debug a crash in official builds.

I packaged it up with the corresponding package. It increases the zip file size a lot, so maybe folks would prefer it to be packaged separately. Creating the PR to open up that discussion.

@georgemoralis
Copy link
Collaborator

i think that anyone who knows to debug should be able to compile a debug build on his own

@hspir404
Copy link
Contributor Author

hspir404 commented Jan 5, 2025

i think that anyone who knows to debug should be able to compile a debug build on his own

It's not for that problem. It's for this problem:

"My game crashed"
"Cool, send me your crash dump"
"Here you go"
dev opens the dump

Shad.exe 0x498021f321
Shad.exe 0x4er81920
Shad.exe 0xbadfood
Shad.exe 0xdeadbeef
kernel32.dll 0x498021f321
nvidiadrivers.lol 0x498021f321

Consistent repros of game crashes can be difficult to come by. Players often don't know exactly what they did (and often aren't terribly technically savvy), and games often behave in non-deterministic ways that makes a crash dump the easiest and fastest way to actually get to the root of the problem.

I also have personally found github actions builds to be convenient sometimes, and then later wished I'd synced locally and built myself instead when I hit a crash and wanted to debug it. So even if it's not used for player crash dumps, it can be useful to (some) devs at times.

There are of course some negatives. Bigger download size if they're in the same zip. Having it in another separate zip might confuse people downloading files ("do I need the "symbols.zip" file?"). Or maybe github actions has limited storage space (I don't know the answer to this). It might also slightly slow down build times. And the project might not be in a phase that focusing on more rare and harder to repro crash fixes makes sense.

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.

2 participants