Skip to content

Features and Usage

Simeon Radivoev edited this page Jul 3, 2017 · 7 revisions

Contents

Commit History

The commit history shows all the commits on a selected branch. The default selected branch once a repository is created is the 'master' branch. The shown branch can be selected form the dropdown button at the top right corner.

![Git history window](https://github.com/simeonradivoev/UniGit/raw/master/Assets/Editor Default Resources/UniGit/Textures/HistoryScreenshot.png)

Every commit can be reverted by clicking on it's reset button. The full commit message and all the changes made can be viewed by clicking the details button.

The Details popup window shows all file changes a commit has made. Information on the type of change made is included as well as the path the each file. The path is divided by folders, and each section can be clicked and the file or folder will be selected in Unity's project browser window. The user can also right click on a file to see the difference between the previous commit or the working tree.

Commit Details Popup

All Git options like pull, pull, merge and fetch can be found in the toolbar. They open their respective wizard windows.

File Difference and Committing

All changes to files can be seen in detail in the Git Diff window. The Diff window separates files into change type categories like added, modified, staged, removed and so on.
Each category can be expanded by clicking on it. They can also be hidden entirely by adjusting the filter option in the toolbar.

![Git Diff Window](https://github.com/simeonradivoev/UniGit/raw/master/Assets/Editor Default Resources/UniGit/Textures/DiffScreenshot.png)

You can quickly jump to the affected object by double clicking it, or you can open more options by right clicking.

File Difference

Meta Changes

Each change can affect a file or it's meta file. UniGit unifies changes to the file meta and show the change on the file with an icon this indicates that the meta file has changed. If an asset and it's meta were both changed, then the asset icon will appear alongside the meta icon.

Stage/Unstage

Each change has 2 distinct types of change. Changes made that are either staged or unstaged. This means that when you commit changes, only files that are "staged" will be committed. UniGit indicates such files with the tick as shown above.

To "stage" or "unstage" files you can right click on a file and do so. This menu is also available in the Project View Window.

Differences/Changes

Differences between changed files and previous version can be show by clicking the Difference and Difference with previous version button in the context menu of each file. These options are also available in the Project View Window.

Reverting

Files can also be reverted to before they were changed. To do so just click the Revert button in the context menu for each file. This option is also available in the Project View Window.

Committing

Committing changes can be done by hitting the 'commit' button. It will prompt you to choose 'commit' or 'commit and push'. Note that if you have selected to commit trough an external program you will be taken to that program once you hit the 'commit' button and the 'commit and push' button will be grayed out. Once the the changes are committed you can push them to your remote repository.

Branches

There are 2 ways of creating a branch.

  • In the settings window under the branches tab there is a 'Create Branch' button. Using that button, a branch can be created from the current active commit.
  • If a specific commit is wanted as a starting point, the 'Git History' windows can be used by hitting the options button on a commit and choosing the 'Branch Out' option. You will then be take to the options window for creating a new branch.

Stash

Stashes can be made or accessed from the Git History Window, by hitting the 'Stash' button in the main toolbar.

Unimplemented Features

Check the full list of planned features here.

Clone this wiki locally