Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 5 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -115,3 +119,4 @@ runs:
depot9Path: ${{ inputs.depot9Path }}
depot9InstallScriptPath: ${{ inputs.depot9InstallScriptPath }}
releaseBranch: ${{ inputs.releaseBranch }}
debugBranch: ${{ inputs.debugBranch }}
10 changes: 7 additions & 3 deletions steam_deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 ..."
Expand All @@ -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
}
Expand Down