Add commandlet for debug symbols upload

.github/workflows/test-linux.yml

@@ -98,6 +98,12 @@ jobs:
           path: checkout
           submodules: recursive
 
+      - name: Update associated engine version in sample project descriptor
+        env:
+          UNREAL_VERSION: ${{ inputs.unreal-version }}
+        run: |
+          sed -i 's/"EngineAssociation":[[:space:]]*"[^"]*"/"EngineAssociation": "'"$UNREAL_VERSION"'"/g' checkout/sample/SentryPlayground.uproject
+
       - name: Extract package to sample/Plugins
         env:
           UNREAL_VERSION: ${{ inputs.unreal-version }}

.github/workflows/test-windows.yml

@@ -42,6 +42,16 @@ jobs:
           path: checkout
           submodules: recursive
 
+      - name: Update associated engine version in sample project descriptor
+        env:
+          WORKSPACE_PATH: ${{ github.workspace }}
+          UNREAL_VERSION: ${{ inputs.unreal-version }}
+        run: |
+          $projectFile = "$env:WORKSPACE_PATH\checkout\sample\SentryPlayground.uproject"
+          $content = Get-Content -Path $projectFile -Raw
+          $content = $content -replace '"EngineAssociation":\s*"[^"]*"', "`"EngineAssociation`": `"$env:UNREAL_VERSION`""
+          Set-Content -Path $projectFile -Value $content
+
       - name: Extract package to sample/Plugins
         env:
           WORKSPACE_PATH: ${{ github.workspace }}

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add commandlet for debug symbols upload ([#1076](https://github.com/getsentry/sentry-unreal/pull/1076))
+
 ### Fixes
 
 - Prevent usage of internal UE logger during crash handling ([#1081](https://github.com/getsentry/sentry-unreal/pull/1081))

plugin-dev/Scripts/post-build-steps-linux.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+TARGET_PLATFORM="$1"
+TARGET_TYPE="$2"
+TARGET_CONFIGURATION="$3"
+PROJECT_FILE="$4"
+PLUGIN_DIR="$5"
+ENGINE_DIR="$6"
+
+# 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
+  chmod +x "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Linux-x86_64"
+fi
+
+# Skip commandlet execution for Editor target type
+if [ "$TARGET_TYPE" = "Editor" ]; then
+  echo "Skipping SentrySymbolUpload commandlet for Editor target type"
+  return 0 2>/dev/null || true
+fi
+
+ENGINE_VERSION=$(grep -o '"EngineAssociation": *"[^"]*"' "$PROJECT_FILE" | cut -d'"' -f4)
+
+if [ "$(printf %.1s "$ENGINE_VERSION")" = "4" ]; then
+  EDITOR_EXE="$ENGINE_DIR/Binaries/Linux/UE4Editor-Cmd"
+else
+  EDITOR_EXE="$ENGINE_DIR/Binaries/Linux/UnrealEditor-Cmd"
+fi
+
+echo "Before SentrySymbolUpload..."
+
+"$EDITOR_EXE" "$PROJECT_FILE" -run=SentrySymbolUpload -target-platform="$TARGET_PLATFORM" -target-type="$TARGET_TYPE" -target-configuration="$TARGET_CONFIGURATION" -unattended -nopause
+
+echo "After SentrySymbolUpload..."

plugin-dev/Scripts/post-build-steps-mac.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+TARGET_PLATFORM="$1"
+TARGET_TYPE="$2"
+TARGET_CONFIGURATION="$3"
+PROJECT_FILE="$4"
+PLUGIN_DIR="$5"
+ENGINE_DIR="$6"
+
+# Copy sentry.dylib to plugin's Binaries\Mac dir if it doesn't exist there to ensure FAB version of the plugin works correctly - Epic obfuscates any extra binaries when pre-building the plugin
+if [ "$TARGET_PLATFORM" = "Mac" ] && [ ! -f "$PLUGIN_DIR/Binaries/Mac/sentry.dylib" ]; then
+  cp "$PLUGIN_DIR/Source/ThirdParty/Mac/bin/sentry.dylib" "$PLUGIN_DIR/Binaries/Mac/sentry.dylib"
+fi
+
+# 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-Darwin-universal" ]; then
+  chmod +x "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Darwin-universal"
+fi
+
+# Skip commandlet execution for Editor target type
+if [ "$TARGET_TYPE" = "Editor" ]; then
+  echo "Skipping SentrySymbolUpload commandlet for Editor target type"
+  exit 0
+fi
+
+ENGINE_VERSION=$(grep -o '"EngineAssociation": *"[^"]*"' "$PROJECT_FILE" | cut -d'"' -f4)
+
+if [[ "${ENGINE_VERSION:0:1}" == "4" ]]; then
+  EDITOR_EXE="$ENGINE_DIR/Binaries/Mac/UE4Editor-Cmd"
+else
+  EDITOR_EXE="$ENGINE_DIR/Binaries/Mac/UnrealEditor-Cmd"
+fi
+
+"$EDITOR_EXE" "$PROJECT_FILE" -run=SentrySymbolUpload -target-platform="$TARGET_PLATFORM" -target-type="$TARGET_TYPE" -target-configuration="$TARGET_CONFIGURATION" -unattended -nopause

plugin-dev/Scripts/post-build-steps-win.bat

@@ -0,0 +1,39 @@
+@echo off
+
+setlocal enabledelayedexpansion
+
+set "TARGET_PLATFORM=%~1"
+set "TARGET_TYPE=%~2"
+set "TARGET_CONFIGURATION=%~3"
+set "PROJECT_FILE=%~4"
+set "PLUGIN_DIR=%~5"
+set "ENGINE_DIR=%~6"
+
+:: Copy crashpad handler executable to plugin's Binaries\Linux dir if it doesn't exist there to enable cross-compilation for Linux on Windows with FAB version of the plugin
+set "CRASHPAD_HANDLER_LINUX=%PLUGIN_DIR%\Binaries\Linux\crashpad_handler"
+if "%TARGET_PLATFORM%"=="Linux" (
+  if not exist "%CRASHPAD_HANDLER_LINUX%" (xcopy "%PLUGIN_DIR%\Source\ThirdParty\Linux\bin\*" "%PLUGIN_DIR%\Binaries\Linux\" /F /R /Y /I)
+)
+
+:: Copy crashpad handler executable to plugin's Binaries\Win64 dir if it doesn't exist there to ensure FAB version of the plugin works correctly - Epic obfuscates any extra binaries when pre-building the plugin
+set "CRASHPAD_HANDLER_WIN=%PLUGIN_DIR%\Binaries\Win64\crashpad_handler.exe"
+if "%TARGET_PLATFORM%"=="Win64" (
+  if not exist "%CRASHPAD_HANDLER_WIN%" (xcopy "%PLUGIN_DIR%\Source\ThirdParty\Win64\Crashpad\bin\*" "%PLUGIN_DIR%\Binaries\Win64\" /F /R /Y /I)
+)
+
+:: Skip commandlet execution for Editor target type
+if "%TARGET_TYPE%"=="Editor" (
+  echo Sentry: Automatic symbols upload is not required for Editor target. Skipping...
+  exit /B 0
+)
+
+for /f "tokens=2 delims=:, " %%i in ('type "%PROJECT_FILE%" ^| findstr /C:"EngineAssociation"') do set "ENGINE_VERSION=%%~i"
+set "ENGINE_VERSION=!ENGINE_VERSION:~0,1!"
+
+if "!ENGINE_VERSION!"=="4" (set "EDITOR_EXE=%ENGINE_DIR%\Binaries\Win64\UE4Editor-Cmd.exe") else (set "EDITOR_EXE=%ENGINE_DIR%\Binaries\Win64\UnrealEditor-Cmd.exe")
+
+"!EDITOR_EXE!" "%PROJECT_FILE%" -run=SentrySymbolUpload -target-platform=%TARGET_PLATFORM% -target-type=%TARGET_TYPE% -target-configuration=%TARGET_CONFIGURATION% -unattended -nopause
+
+endlocal
+
+exit /B 0