diff --git a/README.md b/README.md index 72dd136..ba46812 100644 --- a/README.md +++ b/README.md @@ -182,11 +182,15 @@ The branch within steam that this build will be automatically put live on. Note that the `default` branch [has been observed to not work](https://github.com/game-ci/steam-deploy/issues/19) as a release branch, presumably because it is potentially dangerous. +#### debugBranch + +If set to true, do not exclude debug files from the upload. + ## Other Notes #### Excluded Files / Folders -Certain file or folder patterns are excluded from the upload to Steam as they're unsafe to ship to players: +Certain file or folder patterns are excluded from the upload to Steam as they're unsafe to ship to players, unless debugBranch is set to true: - `*.pdb` - symbols files - Folders that Unity includes in builds with debugging or other information that isn't intended to be sent to players: diff --git a/action.yml b/action.yml index e754c59..bdd0501 100644 --- a/action.yml +++ b/action.yml @@ -82,6 +82,10 @@ inputs: releaseBranch: required: false description: 'The branch within steam that this build will be automatically put live on.' + debugBranch: + required: false + description: 'If set to true, include debug symbols and directories in the upload' + default: false outputs: manifest: description: "The path to the generated manifest.vdf" @@ -115,3 +119,4 @@ runs: depot9Path: ${{ inputs.depot9Path }} depot9InstallScriptPath: ${{ inputs.depot9InstallScriptPath }} releaseBranch: ${{ inputs.releaseBranch }} + debugBranch: ${{ inputs.debugBranch }} diff --git a/steam_deploy.sh b/steam_deploy.sh index bf019b8..d4ec8f0 100755 --- a/steam_deploy.sh +++ b/steam_deploy.sh @@ -41,6 +41,11 @@ until [ $i -gt 9 ]; do else installScriptDirective="" fi + if [ "${debugBranch}" = "true" ]; then + debugExcludes="" + else + debugExcludes='"FileExclusion" "*.pdb"\n "FileExclusion" "**/*_BurstDebugInformation_DoNotShip*"\n "FileExclusion" "**/*_BackUpThisFolder_ButDontShipItWithYourGame*"' + fi echo "" echo "Adding depot${currentDepot}.vdf ..." @@ -57,9 +62,8 @@ until [ $i -gt 9 ]; do "DepotPath" "." "recursive" "1" } - "FileExclusion" "*.pdb" - "FileExclusion" "**/*_BurstDebugInformation_DoNotShip*" - "FileExclusion" "**/*_BackUpThisFolder_ButDontShipItWithYourGame*" + $(echo "$debugExcludes" |sed 's/\\n/\ +/g') $installScriptDirective }