Git Workshop

Janus Valberg-Madsen

2018-10-22 @ Aalborg University

1 / 32

Overview of today2 / 32

Overview of todayWhat is version control, and why should I care?
2 / 32

Overview of today

What is version control, and why should I care?
Overview of the most important Git functions

2 / 32

Overview of today

What is version control, and why should I care?
Overview of the most important Git functions
Overview of GitHub

2 / 32

Overview of today

What is version control, and why should I care?
Overview of the most important Git functions
Overview of GitHub
Live demo showcasing the concepts

2 / 32

Overview of today

What is version control, and why should I care?
Overview of the most important Git functions
Overview of GitHub
Live demo showcasing the concepts
(interactive) Install Git and a client

2 / 32

Overview of today

What is version control, and why should I care?
Overview of the most important Git functions
Overview of GitHub
Live demo showcasing the concepts
(interactive) Install Git and a client
(interactive) Set up a repository on GitHub for your P1 project

2 / 32

Overview of today

What is version control, and why should I care?
Overview of the most important Git functions
Overview of GitHub
Live demo showcasing the concepts
(interactive) Install Git and a client
(interactive) Set up a repository on GitHub for your P1 project
Exercises (if there's time left)

2 / 32

Why use a version control system (VCS)?3 / 32

Why use a version control system (VCS)?You have an annotated history of changes
3 / 32

Why use a version control system (VCS)?

You have an annotated history of changes
It makes collaboration easy

3 / 32

Why use a version control system (VCS)?

You have an annotated history of changes
It makes collaboration easy
It provides you with a full backup of your project

3 / 32

Why use a version control system (VCS)?

You have an annotated history of changes
It makes collaboration easy
It provides you with a full backup of your project
Unlike on services like Dropbox, conflicts are structured and easily resolved

3 / 32

Why use a version control system (VCS)?

You have an annotated history of changes
It makes collaboration easy
It provides you with a full backup of your project
Unlike on services like Dropbox, conflicts are structured and easily resolved

Why Git, specifically?

3 / 32

Why use a version control system (VCS)?

You have an annotated history of changes
It makes collaboration easy
It provides you with a full backup of your project
Unlike on services like Dropbox, conflicts are structured and easily resolved

Why Git, specifically?

Distributed (as opposed to centralised)

3 / 32

Why use a version control system (VCS)?

You have an annotated history of changes
It makes collaboration easy
It provides you with a full backup of your project
Unlike on services like Dropbox, conflicts are structured and easily resolved

Why Git, specifically?

Distributed (as opposed to centralised)
Most popular ⟹ all problems have been had

3 / 32

Why use a version control system (VCS)?

You have an annotated history of changes
It makes collaboration easy
It provides you with a full backup of your project
Unlike on services like Dropbox, conflicts are structured and easily resolved

Why Git, specifically?

Distributed (as opposed to centralised)
Most popular ⟹ all problems have been had
GitHub

3 / 32

Git concepts (functions)4 / 32

The main components of a Git repository

5 / 32

Add: stage changes for committing

6 / 32

Commit: append staged changes to history

7 / 32

Push: changes on local repo ⭢ remote repo

8 / 32

Push: changes on local repo ⭢ remote repo (before)

9 / 32

Push: changes on local repo ⭢ remote repo (after)

10 / 32

Pull: changes on remote repo ⭢ local repo (before)

11 / 32

Pull: changes on remote repo ⭢ local repo (after)

12 / 32

Pull: changes on remote repo ⭢ local repo (after)

Fetch

"Safe" alternative to push
Downloads commits without applying them to the working tree

12 / 32

Branches

Branches are simply labels pointing to commits
Git uses these labels to move around in the commit history

13 / 32

Branches

Branches are simply labels pointing to commits
Git uses these labels to move around in the commit history

14 / 32

Branches

Branches are simply labels pointing to commits
Git uses these labels to move around in the commit history

15 / 32

Checkout: switch to a different branch

16 / 32

Checkout: switch to a different branch

17 / 32

Merge: apply changes from a different branch

18 / 32

Overview

19 / 32

GitHub

20 / 32

View and comment on commits

21 / 32

Keep track of tasks with project boards

22 / 32

Workflow

23 / 32

Time for a demo

⤷ on Windows with GitHub Desktop

24 / 32

Time to set up Git and GitHub

⤷ and get your project repository ready to go

25 / 32

Installing Git

Windows and macOS

Download from https://git-scm.com/

Windows users may have to restart after installation to update the system PATH

Linux

Install via package manager, e.g.

sudo apt install git

Installing a client

Many options, but to highlight a few:

♟ GitHub Desktop

⤷ very simple client, only most basic features; integrates with GitHub

♜ GitKraken

⤷ more features, fancy UI; free for non-commercial use, requires account or GitHub sign-in

♛ Your editor of choice

⤷ many editors support version control from inside the editor
(e.g. Emacs with Magit, or Vim with Fugitive)

♚ The command line 😏

26 / 32

Collaborate with GitHub

❗ signing up with uni email ⟹ free private repos

27 / 32

Collaborate with GitHub

❗ signing up with uni email ⟹ free private repos

Getting started

Go to github.com and sign up with your @student.aau.dk email
Go to education.github.com/pack and click Get your Pack

27 / 32

Setting up a repository (for the repo owner)

NB: Only one person from each group needs to set up a project repository

On GitHub, log in and click New
Fill in the details;
- Repository name: P1
- Description: P1 project for Group <your group id>
- 🗹 Private (can be set later, if you don't have the student discount yet)
- 🗹 Initialize this repository with a README
- Add .gitignore: TeX
Go to Settings 🠪 Collaborators
Add each of your group members as a collaborator
Go to Code and click Clone or download
Click Open in Desktop to get started (or copy the URL and open it with your Git client, if you don't use GitHub Desktop)

28 / 32

Setting up a repository (for the repo owner)

NB: Only one person from each group needs to set up a project repository

Download a template from janusvm.github.io/aau-project-template
Unpack it in the folder where you cloned the project
In GitHub Desktop (or whatever client you use), stage all the new files
Commit with a message like "Add project template files"
Push to GitHub

29 / 32

Setting up a repository (for the collaborators)

Go to the repository page on GitHub (github.com/owner/repo)
Click Clone or download
Clone the repository (by clicking Open in Desktop with GH Desktop, or by using the URL with another client)

After this, you're ready to start writing!

30 / 32

Remember the workflow

Pull from GitHub to get the latest changes from the other group members
Work on the project
Add and Commit related changes together
Pull again, in case new commits have been pushed in the meantime
If there are any conflicts, resolve them and commit the merge
Push your changes to GitHub, so the other group members can get them

31 / 32

Exercises

✨ learngitbranching.js.org ✨

Links and help

These slides: janusvm.github.io/aau-git-workshop
Very simple introduction to Git: think-like-a-git.net
More comprehensive tutorials: www.atlassian.com/git/tutorials
Tips on writing commit messages: chris.beams.io/posts/git-commit
Fixing mistakes: sethrobertson.github.io/GitFixUm/fixup.html
Google :^)

Feel free to ask questions too!

32 / 32

Help

Keyboard shortcuts

↑, ←, Pg Up, k

Go to previous slide

↓, →, Pg Dn, Space, j

Go to next slide

Home

Go to first slide

End

Go to last slide

Number + Return

Go to specific slide

b / m / f

Toggle blackout / mirrored / fullscreen mode

Clone slideshow

Toggle presenter mode

Restart the presentation timer

?, h

Toggle this help