Collaborative git

IMT/LIS 511

Joel Ross
Spring 2019

Homework Check In (<20min?)

Today's Objectives

By the end of class, you should be able to

  • Use git branches to track different versions of your code
     
  • Merge changes between branches
     
  • Resolve merge conflicts
     
  • Collaborate and share code with others through Github
     
  • Host web sites with GitHub Pages [if time]

Code for Today

https://github.com/infx511/branch_practice

FORK  and clone this repo!

Commit History

"First"

 git commit -m "First"

"Second"

"Third"

"Fourth"

 git commit -m "Second"
 git commit -m "Third"
 git commit -m "Fourth"

Git history has been a linear sequence of commits.

HEAD

Why Non-Linear?

  • What if we want to try something new and crazy without breaking code that we've already written?
     

  • What if we want to work on two different features simultaneously?
     

  • What if we want multiple people to work on the same code without stepping on each other's toes?

Branches

Branches allow for non-linear commits.

master

master

master

master

experiment

bugfix

experiment

experiment

Branch Commands

 git branch

List available branches

 git branch [my_branch]

Create a new branch called "my_branch"

 git checkout [my_branch]

Switch to branch "my_branch"

 git checkout -b [my_branch]

Create and switch to branch "my_branch"

 git branch -d [my_branch]

Delete branch "my_branch"

Branch Practice!

  1. Open the README.md file (in VS Code)

  2. Create and checkout a new branch called experiment

  3. Add another item to the end of the list

  4. Add and commit your change

  5. checkout the master branch

  6. Add yet another item to the beginning of the list

  7. Commit your change

  8. Switch between the experiment and master branches (clicking on VS Code in between). See the file contents changing?

Branches

master

master

experiment

experiment

HEAD

HEAD

HEAD

HEAD 

git branch experiment

git checkout experiment

git commit

git commit

git checkout master

git commit

git checkout experiment

HEAD

HEAD

experiment

HEAD

Merging

We can merge two branches back together, producing a commit that contains the combined changes from both branches

master

master

experiment

HEAD

HEAD

Merging

 git merge [other_branch]

Merges changes from other_branch into the current branch.

A new commit is created on the current branch containing the merged content.

Merging Practice

  1. Make sure you are on the master branch
    (use git branch to check; the current branch has a *)

  2. Use git merge to merge the experiment branch into master branch.

    • If you get dropped into vi, hit :wq (colon then w then q) to accept the message.

  3. Check in VS Code that the file now contains both sets of changes!

Merging Practice II

  1. You should be on the master branch.

  2. Create and checkout a new branch called danger

  3. On the danger branch, change the word "kittens" to "puppies". Remember to commit your change.

  4. checkout the master branch again.

  5. Change the word "kittens" to something else that is pleasant. commit your change.

  6. Use git merge to merge the danger branch into master branch
     

  7. DON'T PANIC

Merge Conflicts

A merge conflict is when two commits from different branches include different changes to the same code.

Git does not know which version to keep, so makes you choose. 

Merge conflicts must be resolved manually

Conflicts are expected!

Resolving Conflicts

In order to resolve a conflict, you need to edit the file (code) so that you pick which version to keep.
git will add "code" where you need to make a decision: 

<<<<<<< HEAD

# This is the code from the "local" version (the branch you merged INTO)
# a.k.a the version from the HEAD commit

message = "I am an original"
lyric = "I've got no strings to hold me down"

# There can be multiple lines that conflict, including lines being deleted

=======

# This is the code from the "remote" version (the branch you merged FROM)

message = "I think I'm a clone now..."

# The lines need not be related in content, they've just changed in a way
# that git can't figure out which to keep!

>>>>>>> f292a3332aedc8df3e8e8cf22ca3debc214c6460

the two versions to pick from

a divider between the versions

end conflict area

git add .
git commit -m "Merge branch 'other'"

Resolving Conflicts

  • Use git status to see which files have merge conflicts. Note that files may have more than one!
     
  • Delete the <<<<<<< and ======= and >>>>>>> !!
     
  • Once you're satisfied that the conflicts are all resolved, add and commit your changes (the code you "modified" to resolve the conflict):

GitHub and Branches

Because GitHub just hosts normal repositories, GitHub has branches as well! These can (but need not) correspond with the branches on your local machine.

Remote Branch Cmds

 git branch -a

List all branches (including remote ones) 

 git pull [remote] [branch]

Shortcut for git fetch then git merge 

 git fetch

Download remote branches into local repo
Are still listed as "remote" branches that need to be merged

Can cause conflicts!

 git push [remote] [branch]

Remote Branch Cmds

Upload commits to remote
Essentially has the remote branch merge (rebase) your changes.

 git push [remote] --all

Push all branches

Branching Questions?

Multiplayer Git

Do you have a partner for a6 yet?

Collaboration

Multiple people's local repositories can be linked to the same remote repository, allowing them to push and pull to the same central location.

Collaboration Practice

  1. Partner up with your partner ("Howdy pardn'r")

  2. One person should accept their homework repository and add the other as a collaborator





     

  3. The added person will then need to clone their partner's repo on their machine

    • Remember to do this in a different folder!

Collaboration Practice

  1. Person 1: edit the README.md file so it includes a message to your partner (be nice)

    • add and commit your change as usual.
       

  2. Person 2: create a new script partner.py that prints a message to your partner (be nice)

    • add and commit as usual.
       

  3. Person 1 should push their changes to Github
     

  4. Then Person 2 should push their changes to Github

    • What happened?!

Collaboration Practice

  1. Person 2: pull to merge in Person 1's message

    • Both people should confirm the changes are local!
       

  2. Person 2: push your changes to Github
     

  3. Person 1: pull in Person 2's message and merge

    • You both should now have up-to-date code!

Collaboration Practice II

  1. Person 1: edit the partner.py file so that it prints a different message. Change the existing line of code.

    • add and  commit your change as usual.
       

  2. Person 2: edit the partner.py file so that it prints a different message. Change the existing line of code.

    • add and commit as usual.
       

  3. Person 2 should push their changes to Github

    • What happened?

  4. Then Person 1 should push their changes to Github.
    But they need to pull first...

git add .
git commit -m "Merge branch 'other'"

Resolving Conflicts

  • Use git status to see which files have merge conflicts. Note that files may have more than one!
     
  • Delete the <<<<<<< and ======= and >>>>>>> !!
     
  • Once you're satisfied that the conflicts are all resolved, add and commit your changes (the code you "modified" to resolve the conflict):

Make sure both partners have all the changes!!

GitHub Pages

A GitHub service that hosts web pages ( .html files) found in a repository's gh-pages branch. 

# Make sure you are on the `master` branch
git branch

# Checkout a new gh-pages branch from here. This branch will 
# have the same commits as `master` to this point
git checkout -b gh-pages

# Upload web site to GitHub
git push -u origin gh-pages

Visit published page at:

https://GITHUB-USERNAME.github.io/REPO-NAME

https://help.github.com/articles/user-organization-and-project-pages/

Action Items!

  • Assignment 5 due Wednesday
  • Assignment 6 due next week
    • Make sure you have a partner!
  • Review "Programming Skills for Data Science" Ch 20 (online)
  • Read Chapter 12 (required)
     

Next time: web APIs