game-ci / steam-deploy

Github Action to deploy a game to Steam
MIT License
227 stars 63 forks source link

Exclude another Unity folder: `${currentDepotPath}_BackUpThisFolder_ButDontShipItWithYourGame` #24

Closed bilalakil closed 2 years ago

bilalakil commented 2 years ago

Changes

Checklist

bilalakil commented 2 years ago

Thanks for mentioning this folder @davidmfinol - I was thinking the BurstDebug one that I first excluded didn't match my memory 🤔 I guess it differs between Unity versions now.

Are you able to confirm the functionality with this folder?

davidmfinol commented 2 years ago

For my windows builds, I actually use a custom build name, in which case, the path looks like this: StandaloneWindows/cgs_BackUpThisFolder_ButDontShipItWithYourGame. Maybe we can make the pattern look like $currentDepotPath/*_BackUpThisFolder_ButDontShipItWithYourGame* to account for this? Could do the same for BurstDebugInformation_DoNotShip?

webbertakken commented 2 years ago

Sounds like we need something like a gitignore file, but for deploying to marketplaces.

webbertakken commented 2 years ago

Yea if these wildcards work it would be rather perfect.

Also note that not all glob matchers accept **/ so keeping depotpath as part of the path might be needed.

bilalakil commented 2 years ago

I tried a few options and, interestingly, all 3 of them work:

  "FileExclusion" "**/*_BackUpThisFolder_ButDontShipItWithYourGame*"
  "FileExclusion" "*/*_BackUpThisFolder_ButDontShipItWithYourGame*"
  "FileExclusion" "$currentDepotPath/*_BackUpThisFolder_ButDontShipItWithYourGame*"

Any preferences?

I'd personally pick the first one because it's a more conventional glob format so the intention maybe comes across more clearly? Very light preference though.

I've updated the commit to match my recommendation so if there's no disagreement it can be merged once approved - but still happy to change it per other recommendations.

webbertakken commented 2 years ago

I'm fine with your preference as well. Let's go with that.