Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/doitian/unity-git-hooks

Git hooks for Unity3D project
https://github.com/doitian/unity-git-hooks

Last synced: 13 days ago
JSON representation

Git hooks for Unity3D project

Awesome Lists containing this project

README

        

# Unity Git Hooks

Git hooks for Unity project.

To manage a Unity project, the Assets meta file should also been added to
repository. But sometimes the meta files and the corresponding asset files
and directories are inconsistent, then meta files will lead to conflicts when
a team is collaborating on the same code base.

## Features

- Stop committing if meta files and asset files and directories are
inconsistent. If an asset file is added, its meta file and meta files of all
its containing directories should also been added. If a asset file is
deleted, its meta file and meta files of all its empty containing
directories should also been deleted. When meta files are added/deleted,
asset files and directories should also been consistent.
- Delete empty asset directories after checkout and merge. Unity keep
generating meta file for empty asset directory, but git does not trace
directory.

## Usage

Copy files `post-checkout` `post-merge` and `pre-commit` to .git/hooks in your
git repository. If you also have hooks defined in these files, append them to
existing files.

It is assumed that Assets directory is located in the root directory of the repository. You doesn't need set path to "Assets" folder manually if you "Assets" folder has position in the same folder as ".git". Example:
```
.
+-- ProjectName
| +-- .git
| +-- Assets
```
Otherwise you need set full path relative `.git`. Following example tells the scripts that the assets directory is client/Assets Example:
```
.
+-- ProjectName
| +-- .git
| +-- client
| | +-- Assets
```
```
git config unity3d.assets-dir client/Assets
```