Developing FreeCAD with GitKraken

From FreeCAD Documentation
Revision as of 10:28, 30 July 2017 by Kunda1 (talk | contribs) (Added squashing and fixed other parts)

Template:UnderConstruction

Setup git Development

  1. Download GitKraken (There are different ways to download GitKraken depending on your OS. I use an Arch Linux based distro called Manjaro and added it through my package manager)
  2. In your web browser go to: https://github.com/FreeCAD/FreeCAD
  3. Click the Fork button. This will clone the FreeCAD/FreeCAD repo to your own account. In other words the URL to access your fork of FreeCAD is:
    https://github.com/GITUBUSERNAME/FreeCAD.git
  4. Open GitKraken and go to File > Clone Repo
  5. GitKraken will now git clone your repository
    • Now an important point: Please read the different between origin vs. upstream remote repos. Essentially your fork of FreeCAD is the origin repo. The official FreeCAD git repo FreeCAD/FreeCAD is your upstream. You now need to set the upstream repo as FreeCAD.
  6. Go to File > Open Terminal
  7. Enter the following to set up your upstream remote repo
    Code|git remote add upstream https://github.com/YOURGITUHUBUSERNAME/FreeCAD.git
  8. Now check what remote branches you have set by typing:
    git remote -v
  9. You should see something like this in the terminal:
    origin	https://github.com/foobar/FreeCAD (fetch)
    origin	https://github.com/foobar/FreeCAD (push)
    upstream	https://github.com/FreeCAD/FreeCAD.git (fetch)
    upstream	https://github.com/FreeCAD/FreeCAD.git (push)
  10. Switch back to GitKraken

Deciphering the GitKraken Interface

  • Orientation:
    • Local = local machine
      • Local master = your local copy FreeCAD <= symbolized as Blue in Screenshot)
    • Remote = Remote GitHub repos
      • Remote Upstream = Official FreeCAD repo (AKA FreeCAD/FreeCAD) <= Symbolized as Green in Screenshot
      • Remote Origin = Fork of FreeCAD/FreeCAD (should look something like: github.com/YourGitHubUsername/FreeCAD) <= Symbolized as Red in Screenshot

Notice

That both remote origin master and local master are a few commits behind upstream in the above screenshot. You can remedy this by Rebasing


Rebasing

  • Checkout the Local Master branch by double clicking on it (this is the equivalent of typing git branch master in the terminal)
  • Move the mouse to the where latest Upstream commit is, right click mouse and choose Rebase master on upstream/master (this will pull down the Upstream changes in to your Local master)
  • Move the mouse and press the Push button. GitKraken (This pushes from your 'Local master' to 'Remote Origin master')

Now all your repos are in sync!

Squashing Commits

Squashing is when you have several commits you want to condense down in to one commit. From the GitKraken manual: Squashing is available for commits that meet the following requirements:

   Selection contains more than one commit
   The youngest commit (by commit date) is also the current HEAD commit
   Genealogically consecutive
   Chronologically consecutive
   The oldest commit in the list has a parent

If all these conditions are met, the Squash option appears when you right click the commit node. See screencast at: https://support.gitkraken.com/img/documentation/working-with-files/commits/squash.gif