Migrate debug symbol upload to Python script #1114
Conversation
| -e SENTRY_AUTH_TOKEN="$SENTRY_AUTH_TOKEN" \ | ||
| -e SENTRY_ORG="$SENTRY_ORG" \ | ||
| -e SENTRY_PROJECT="$SENTRY_PROJECT" \ |
There was a problem hiding this comment.
There now is a org-auth-token that would allow us to omit the SENTRY_ORG.
There was a problem hiding this comment.
Let’s keep setting the organization explicitly for now as things could get confusing if the "wrong" token type is used.
| id: run-tests | ||
| env: | ||
| EDITOR_BINARY: ${{ inputs.unreal-version == '4.27' && 'UE4Editor.exe' || 'UnrealEditor.exe' }} | ||
| SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY: true |
There was a problem hiding this comment.
Is that getting used anywhere else?
There was a problem hiding this comment.
In the upload debug symbol python script, it's getting forwarded to docker environment
| # Grant execute permissions to sentry-cli binary (FAB version of the plugin doesn't preserve file permissions) | ||
| if [ -f "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Linux-x86_64" ]; then |
There was a problem hiding this comment.
I don't understand how this works. The .sh does have permissions to grant permissions?
There was a problem hiding this comment.
It can grant permissions if the user running it has permissions to do so.
| if [ -f "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Linux-x86_64" ]; then | ||
| chmod +x "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Linux-x86_64" | ||
| fi | ||
|
|
There was a problem hiding this comment.
The Windows cross-compilation copies the crash handler, but the Linux-native script doesn't?
There was a problem hiding this comment.
Manual crashpad copying is only required when using the FAB version of the plugin. Since the Epic Games Launcher is not available on Linux, users can’t download the Sentry plugin from the FAB there, so this step isn’t needed for the native build.
Co-authored-by: Stefan Jandl <reg@bitfox.at>
3 participants
This PR changes the debug symbol upload mechanism by replacing platform-specific shell scripts with a unified Python-based solution.
The proposed approach should make maintaining the symbol upload functionality easier and avoids the limitations encountered when attempting to implement the similar commandlet (#1076).
Note: Unreal Engine includes Python at
$(EngineDir)/Binaries/ThirdParty/Python3/so plugin users don’t need to perform any additional environment configuration or install dependencies.Key changes:
upload-debug-symbols.shandupload-debug-symbols-win.bat) with a single Python script (upload-debug-symbols.py)post-build-steps-{platform}.sh/bat) that handle plugin's binaries management and invoke the Python scriptSentry.upluginPostBuildSteps to use cleaner delegation pattern inspired earlier by the commandlet approachCloses #542
Closes #972