Recommended gitignore for AGBT?

Unity Engine
1

The asset bundle graph tool is a very nice tool for us to build assetbundles, and I’d like to integrate it into a project. I am, however, a bit confused what exactly all data is for. Which parts are local files, and which should be committed to a git repo for others to work the same way?

  • Cache: It sounds very much like it can be ignored?

  • SavedSettings: I think this is where node settings are saved, so this should definitely be pushed right?

  • SettingFiles: A bit unclear:

  • BuildMap: Updates when any asset in bundle is added or removed, but looks like it can be ignored
  • AssetReferenceDB: Like buildmap, but has reference to pretty much all files. Could ignore this?
  • Batch Config: Can be pushed

With all of these that can be potentially ignored, the question also remains if the AGBT can deal with assets changing without also getting its own files updated. While AGBT is really nice, it does throw errors sometimes / does inconsistent things with its editor behavior, so anything I do with it makes me feel unsure if it can handle it.

2

Thanks for pointing this out - this should be written in Manual.

Here is ignore/do not ignore guidance to current version (1.3)

Ignore from committing:

  • Everything under Cache
  • AssetReferenceDB
  • AssetBundleBuildMap

Do not ignore:

  • Everything under SavedSettings
  • SettingFiles/BatchBuildConfig

A bit of descriptions to each files/folders:

  • Cache: Stores files configurations for the files created by graphs. Deleting cache folder will cause related files (such as prefabs built by graph) to recreate when graph runs, but clearing cache folder should not do any harm to your project. (you can clear cache from menu, too)
  • SavedSettings: Stores important configurations meant to be kept, such as import settings you configured. This should be kept and shared across team to make the graph work properly.
  • SettingFiles/AssetReferenceDB: Stores lightweight metadata for assets. Deleting AssetReferenceDB should be harmless as this file and data is recreated from AssetDatabase and assets if missing. No point to version this file - Should be ignored.
  • SettingFiles/AssetBundleBuildMap: Stores current asset bundle configurations, used for AssetBundleBrowser integration. This file is also recreated if missing. Not recommended for sharing.
  • SettingFiles/BatchBuildConfig: Stores GraphCollection settings you created in Batch Build Window. This should be shared across team.

OK, so there is clearly a room for improvement from ignore/push standpoint other than documentation.

I will put this into my backlog to improve file/folder structure more intuitive.

1 Like