How to Setup Git

Tag the commit your project is currently on when a build uploads, so you can always find the exact code that produced a build.

This service uses the git already installed on your PC. There is no account, token or website to sign up to.

---

1. Setup Preferences: Edit->Preferences->Build Uploader->Services->Git

Git has no Project Settings page - everything is here.

• Turn on Enabled
• Look at Git Path:
  • If the label is green, git was found and you are done. The line underneath tells you which git it found and what version
  • If the label is red, keep reading

If git wasn't found

• Leave Git Path empty if git is installed normally. The Build Uploader will use the git on your system PATH, which is what most machines want
• If you don't have git, download and install it, restart Unity, then press Refresh
  • (The ? button next to Git Path opens the same download page)
• If git is installed somewhere unusual, press ... and pick the git executable directly
  • On Windows that is usually C:\Program Files\Git\bin\git.exe
• Press Refresh after any change to re-check

The message under the field tells you what went wrong:

Message	What it means
Using <path> - <version>	Working. Nothing to do
No git found on your PATH	Git isn't installed, or Unity was open before you installed it. Install it and restart Unity
That path did not run	The path you typed isn't the git executable

!NOTE: Your project must actually be inside a git repository for tagging to work. If you have never run git init here, there is no commit to tag.

---

2. Use it in an Upload Config

• Go to Window->Build Uploader->Open Window
• Add a Git Tag Commit action to your Upload Config
  • Tag: the name of the tag to create. Comes pre-filled with a sensible default
    • Supports {keys} - see String Formatter
    • Git tag names cannot contain spaces or any of ~ ^ : ? * [ \, cannot contain .. or @{, and cannot end with . or .lock
    • The Build Uploader checks this for you before the upload starts and shows an error if the tag would be rejected
  • Auto Push: turn on to push the tag to your remote as soon as it's created. Leave off to only tag locally
  • Remote: which remote to push to. origin for almost everyone
• Set Triggers to OnTaskFinished and When To Execute to IfSuccessful so you only tag builds that actually uploaded

!NOTE: The tag is created on whatever commit is currently checked out. Commit your work before starting the upload, or you'll tag the previous commit.