December 19, 2023

GIT LFS Plugin

https://github.com/ProjectBorealis/UEGitPlugin

All usecases shown here in the link

Here is some of commonly used

Pulling latest from within the editor:

You can pull the latest changes from your currently checked-out branch within the editor. This doesn't always work smoothly, but effort has been made to improve this process. It is still recommended to always save changes before doing this, however.

Submitting changes up-stream:

Submit to revision control will create a local commit, push it, and release your file lock.

If you make any change Editor show you a message that you need to check-out file

If you try to save all or this file you get a popup window where you need to confirm what files to checkout(sometimes unreal make changes to files that you dont touch - so always check what you want to checkout)

When you need to send your changes to server use this button

And you get a new popup window asking you what files you want to send to server and ask for Commit description(it means that you always need to comment what you do every time - better description - easier to find and rollback in future)

If you submit change not from this plugin, for example from GitHubDesktop - it works, but dont checkin files to revision control after - so no one can edit your checked out files. You need to do steps in "Reset check out" section.

Revert changes

If you make any changes and in any case need to reset files back - you can use Revert button

Sometimes i have problems with this button and Unreal crash.

In this case you need to use GitHub Desktop app to revert changes

But if you use GitHubDesktop to Discard changes - it do it, but dont checkin files. Go to "Reset check out" section.

Reset check out

Sometimes you need to do this.

If you only need to reset a few files, you can use git bash.

Use command "git lfs locks" to see what files are checked out

Here you can see a list of checked out files, to checkin it use command "git lfs unlock --id ####" where #### is your id

if you need to unlock many files at once - you can install TortoiseGit.

After that select all files needed and press Unlock.