Using GitHub

June 28, 2019
Uncategorized

So, Git is confusing. Especially if you are not coming from a computer programming background, hell even if you are it is still confusing. The concepts behind Git is not complicated at all but most sources online focus so much on teaching you the commands to use Git that most people don’t understand what it is they are doing mostly because of the cryptic terminology. That was definitely the case with me till I found this helpful guide https://github.com/UnseenWizzard/git_training If you have been struggling, this short tutorial will change your life.

Like most tutorials online, I will say that you probably will not need to know all of the information in that tutorial to get started using Git. However, understanding all of the concepts and what they do will make using and learning Git much more enjoyable.

Below are the instructions to set up Git with MATLAB from the MathWorks documentation site.

Set Up Git Source Control In MATLAB

About Git Source Control

Git™ integration with MATLAB® provides distributed source control with support for creating and merging branches. Git is a distributed source control tool, so you can commit changes to a local repository and later synchronize with other remote repositories.

Git supports distributed development because every sandbox contains a complete repository. The full revision history of every file is saved locally. This enables working offline, because you do not need to contact remote repositories for every local edit and commit, only when pushing batches of changes. In addition, you can create your own branches and commit local edits. Doing so is fast, and you do not need to merge with other changes on each commit.

Capabilities of Git source control:

  • Branch management
  • Local full revision history
  • Local access that is quicker than remote access
  • Offline working
  • Tracking of file names and contents separately
  • Enforcing of change logs for tracing accountability
  • Integration of batches of changes when ready

These capabilities do not suit every situation. If your project is not appropriate for offline working or your repository is too large for a full local revision history, for example, Git is not the ideal source control. In addition, if you need to enforce locking of files before editing, Git does not have this ability. In that situation, SVN is the better choice.

When you use Git in MATLAB, you can:

  • Create local Git repositories.
  • Pull and fetch files from remote Git repositories.
  • Create and switch branches.
  • Merge branches locally.
  • Commit locally.
  • Push files to remote Git repositories.

This diagram represents the distributed Git workflow.

Install Command-Line Git Client

If you want to use Git to merge branches in MATLAB, you must also install a command-line Git client that is available systemwide. You can use other Git functionality without any additional installation.

Some clients are not available systemwide, including the mingw32 environment provided by GitHub® (Git Shell on the Start menu). Installing command-line Git makes it available systemwide, and then MATLAB can locate standard ssh keys.

Check if Git is available by using the command !git in MATLAB. If Git is not available, install it. After you have installed a command-line Git client and registered your files as binary, you can use the merging features of Git in MATLAB.

On Windows®:

  1. Download the Git installer and run it. You can find command-line Git at:https://msysgit.github.io/
  2. In the section on adjusting your PATH, choose the install option to Use Git from the Windows Command Prompt. This option adds Git to your PATH variable, so that MATLAB can communicate with Git.
  3. In the section on configuring the line-ending conversions, choose the option Checkout as-is, commit as-is to avoid converting any line endings in files.
  4. To avoid corrupting binary files, before using Git to merge branches, register the binary files.

On Linux®, Git is available for most distributions. Install Git for your distribution. For example, on Debian®, install Git by entering:

sudo apt-get install git

On Mac, on Mavericks (10.9) or above, try to run git from the Terminal. If you do not have Git installed already, it will prompt you to install Xcode Command Line Tools. For more options, see https://git-scm.com/doc.

Register Binary Files with Git

If you use third-party source control tools, you must register your MATLAB and Simulink® file extensions such as .mlx, .mat, .fig, .mdl, and .slx as binary formats. If you do not register the extensions, these tools can corrupt your files when you submit them by changing end-of-line characters, expanding tokens, substituting keywords, or attempting to automerge. Corruption can occur whether you use the source control tools outside of MATLAB or if you try submitting files from MATLAB without first registering your file formats.

Also check that other file extensions are registered as binary to avoid corruption at check-in. Check and register files such as .mdlp, .slxp, .sldd, .p, MEX-files, .xlsx, .jpg, .pdf, .docx, etc.

After you install a command-line Git client, you can prevent Git from corrupting your files by inserting conflict markers. To do so, edit your .gitattributes file to register binary files. For details, see:

https://git-scm.com/docs/gitattributes
  1. If you do not already have a .gitattributes file in your sandbox folder, create one at the MATLAB command prompt:edit .gitattributes
  2. Add these lines to the .gitattributes file:*.mlx -crlf -diff -merge *.mat -crlf -diff -merge *.fig -crlf -diff -merge *.p -crlf -diff -merge *.slx -crlf -diff -merge *.mdl -crlf -diff -merge These lines specify not to try automatic line feed, diff, and merge attempts for these types of files.
  3. Check for other file types you use that you also need to register as binary to avoid corruption at check-in. Check for files such as .mdlp, .slxp, MEX-files (.mexa64, .mexmaci64, .mexw64), .xlsx, .jpg, .pdf, .docx, etc. Add a line to the attributes file for each file type you need.Examples:*.mdlp -crlf -diff -merge *.slxp -crlf -diff -merge *.sldd -crlf -diff -merge *.mexa64 -crlf -diff -merge *.mexw64 -crlf -diff -merge *.mexmaci64 -crlf -diff -merge *.xlsx -crlf -diff -merge *.docx -crlf -diff -merge *.pdf -crlf -diff -merge *.jpg -crlf -diff -merge *.png -crlf -diff -merge
  4. Restart MATLAB so you can start using the Git client.

Add Git Submodules

To reuse code from another repository, you can specify Git submodules.

To clone an external Git repository as a submodule:

  1. Right-click in the MATLAB Current Folder browser, and select Source Control > Submodules.
  2. In the Submodules dialog box, click the + button.
  3. In the Add Submodule dialog box, in the Remote box, specify a repository location. Optionally, click Validate.
  4. In the Path box, specify a location for the submodule and click OK. The Submodules dialog box displays the status and details of the submodule.
  5. Check the status message, and click Close.

Use Fetch to Get Latest Submodule Version

When you want to manage the added submodule, open the Submodules dialog box.

  1. To get the latest version of a submodule, in the Submodules dialog box, click Fetch.
  2. After fetching, you must merge. Check the Status message in the Submodules dialog box for information about your current branch relative to the remote tracking branch in the repository. When you see the message Behind, you need to merge in changes from the repository to your local branch.
  3. Click Branches and merge in the origin changes to your local branch using the Branches dialog box. See Fetch and Merge.

Use Push to Send Changes to the Submodule Repository

If you make changes in your submodule and want to send changes back to the repository:

  1. Perform a local commit in the parent folder.
  2. Open the Submodules dialog box and click Push.

If you want other users to obtain your changes in the submodule when they clone the parent folder, make sure the index and head match.

  1. In the Submodules dialog box, check the index and head values. The index points to the head commit at the time you first cloned the submodule, or when you last committed the parent folder. If the index and head do not match, you must update the index.
  2. To update the index, commit your changes in the parent folder, and then click Push in the Submodules dialog box. This action makes the index and head the same.