Skip to content

Commit 7a0e17f

Browse files
authored
add option to keep debug symbols for build (#84)
* add option to keep debug symbols for build * update readme
1 parent 99e7436 commit 7a0e17f

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,15 @@ The branch within steam that this build will be automatically put live on.
182182

183183
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.
184184

185+
#### debugBranch
186+
187+
If set to true, do not exclude debug files from the upload.
188+
185189
## Other Notes
186190

187191
#### Excluded Files / Folders
188192

189-
Certain file or folder patterns are excluded from the upload to Steam as they're unsafe to ship to players:
193+
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:
190194

191195
- `*.pdb` - symbols files
192196
- Folders that Unity includes in builds with debugging or other information that isn't intended to be sent to players:

action.yml

+5
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ inputs:
8282
releaseBranch:
8383
required: false
8484
description: 'The branch within steam that this build will be automatically put live on.'
85+
debugBranch:
86+
required: false
87+
description: 'If set to true, include debug symbols and directories in the upload'
88+
default: false
8589
outputs:
8690
manifest:
8791
description: "The path to the generated manifest.vdf"
@@ -115,3 +119,4 @@ runs:
115119
depot9Path: ${{ inputs.depot9Path }}
116120
depot9InstallScriptPath: ${{ inputs.depot9InstallScriptPath }}
117121
releaseBranch: ${{ inputs.releaseBranch }}
122+
debugBranch: ${{ inputs.debugBranch }}

steam_deploy.sh

+7-3
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ until [ $i -gt 9 ]; do
4141
else
4242
installScriptDirective=""
4343
fi
44+
if [ "${debugBranch}" = "true" ]; then
45+
debugExcludes=""
46+
else
47+
debugExcludes='"FileExclusion" "*.pdb"\n "FileExclusion" "**/*_BurstDebugInformation_DoNotShip*"\n "FileExclusion" "**/*_BackUpThisFolder_ButDontShipItWithYourGame*"'
48+
fi
4449

4550
echo ""
4651
echo "Adding depot${currentDepot}.vdf ..."
@@ -57,9 +62,8 @@ until [ $i -gt 9 ]; do
5762
"DepotPath" "."
5863
"recursive" "1"
5964
}
60-
"FileExclusion" "*.pdb"
61-
"FileExclusion" "**/*_BurstDebugInformation_DoNotShip*"
62-
"FileExclusion" "**/*_BackUpThisFolder_ButDontShipItWithYourGame*"
65+
$(echo "$debugExcludes" |sed 's/\\n/\
66+
/g')
6367
6468
$installScriptDirective
6569
}

0 commit comments

Comments
 (0)