Git hooks for Unity project to try and avoid common mistakes.
Unity projects use .meta files to manage assets, but these can become
inconsistent with the actual assets, especially when mixed with version control.
This can lead to conflicts.
Unity also seems to use platform-specific versioning, that can result in ping-pong commits of the project version.
- Stop committing if meta files are inconsistent - if a file is added, check it
has a
.metafile, if removed, check there isn't one, if moved, check it was also moved, and do the same in reverse for meta files without base files. The GUID is also checked for consistency, stopping the case that Unity generated a new one after accidental deletion. - Delete empty asset directories after checkout and merge. Unity generates
.metafiles for empty asset directories, but git ignores them. This causes hanging.metafiles. - Check for version problems due to platform-specific versioning.
Requires Python 3.5. Do a pip install -r requirements.txt to get the
dependencies.
Run install-hooks.sh/install-hooks.bat from within the repository you wish
to add the hooks to.
The hooks are in order from the directories in hooks - you can remove files to permanently disable them, or rename them to disable them temporarily. Hooks are expected to be in the appropriate folder, and run in order based on name. They must begin with a number to be run.
You may want to customise what hooks get run. For example, the rename hooks are prone to false positives (due to git mixing up renames), and so may not be suitable as server-side hooks.
For git for Windows users the default python3 installation will not add a "python3" executable to the path. To add one yourself simply ensure that the python3 installation directory is on the path and add a symbolic link from "python.exe" to "python3.exe" as such:
cd [python installation dir]
mklink "python3.exe" "python.exe"
The result should be a link file called "python3.exe" in the python installation directory pointing at "python.exe".