Fork me on GitHub

Git introduction: Sharing repositories online

Overview

Teaching: 10 min
Exercises: 10 min
Questions
  • How can I set up a public repository online?
  • How can I clone a public repository to my computer?
  • How does version control scale from 1 to N users per repository?
Objectives
  • We get a feeling for remote repositories (more later).
  • We are able to publish a repository on the web.
  • We are able to fetch and track a repository from the web.

From our laptops to the web

We have seen that creating Git repositories and moving them around is simple and that is great.

So far everything was local and all snapshots, branches, and tags are saved under .git.

If we remove .git, we remove all Git history of a project.

  • What if the hard disk fails?
  • What if somebody steals my laptop?
  • How can we collaborate with others across the web?

Remotes

We will learn how to work with remote repositories in detail in the collaborative distributed version control lesson.

In this section we only want to get a taste to prepare us for other lessons where we will employ GitHub.

Our goal is to publish our guacamole recipe on the web. Don’t worry, you will be able to remove it afterwards.

To store your git data on another server, you use remotes. A remote is a repository on its own, with its own branches We can push changes to the remote and pull from the remote.

You might use remotes to:

  • Back up your own work.
  • To collaborate with other people.

There are different types of remotes:

  • If you have a server you can ssh to, you can use that as a remote.
  • GitHub is a popular, closed-source commercial site.
  • GitLab is a popular, open-core commercial site. Many universities have their own private GitLab servers set up.
  • Bitbucket is yet another popular commercial site.
  • Another option is NotABug
  • We especially encourage course participants to use our new Nordic research software repository platform, for more information see https://coderefinery.org/repository/. This is GitLab, free for researchers and allows private, cross-university sharing.

Why we use GitHub

One option to host your repository on the web is GitHub.

GitHub is a for-profit service that hosts remote git repositories for you. It offers a nice HTML user interface to browse the repositories and handles many things very nicely.

It offers unlimited public and private repositories free of charge and costs a monthly fee if you want access to the pro-tools or need more than 3 collaborators for your private repos. These features had made GitHub very popular with many open source providers

CodeRefinery does not in any way endorse the use of GitHub. There are many commercial and open-source alternatives, just check the list above. In the end, it is a balance between control and visibility, and we use GitHub because you are likely to have to use it for other software anyway.

Set up GitHub account: By now you should already have set up a GitHub account but if you haven’t, please do so here. But it is OK if you want to use GitLab or Bitbucket or NotABug or another platform instead (although we will practice collaborative Git on GitHub tomorrow).


Type-along: Create a new repository on GitHub

For the rest of this page, we will make a new repository for our guacamole recipe on Github, send our code to it, and then see how others can get the code from it.

Make sure that you are logged into GitHub.

To create a repository we either click the green button “New” (top left corner):


Or if you see your profile page, there is a “+” menu (top right corner):


Yet another way to create a new repository is to visit https://github.com/new directly.


On this page choose a project name. For the sake of this exercise do not select “Initialize this repository with a README” (what will happen if you do?):


Once you click the green “Create repository”, you will see a page similar to:

What this means is that we have now an empty project with either an HTTPS or an SSH address: click on the HTTPS and SSH buttons to see what happens.

To push changes to the project you will either need SSH keys for the SSH address (preferred) or you will have to use your GitHub username and password when using the HTTPS address. If you don’t know what to do, use HTTPS.


Pushing our guacamole recipe repository to GitHub

We now want to try the second option that GitHub suggests:

… or push an existing repository from the command line

  1. Now go to your guacamole repository on your computer.
  2. Check that you are in the right place with git status.
  3. Copy paste the three lines to the terminal and execute those, in my case (you need to replace the “user” part and possibly also the repository name):
git remote add origin https://github.com/user/recipe.git
git branch -M main
git push -u origin main

The meaning of the above lines:

  • add a remote reference with the name “origin”
  • rename current branch to “main”
  • push branch “main” to “origin”

You should now see:

Enumerating objects: 3, done.
Counting objects: 100% (3/3), done.
Writing objects: 100% (3/3), 221 bytes | 221.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
To github.com:bast/recipe.git
 * [new branch]      main -> main
Branch 'main' set up to track remote branch 'main' from 'origin'.

Reload your GitHub project website and - taa-daa - your commits should now be online!

What just happened? Think of publishing a repository as uploading the .git part online.


Cloning a repository

Now other people can clone this repository and contribute changes. In the collaborative distributed version control lesson we will learn how this works.

At this point only a brief demo - if you copy the SSH or HTTPS address, you can clone repositories like this (again adapt the “namespace/repository.git” part):

$ git clone https://github.com/user/recipe.git

This creates a directory called “recipe” unless it already exists. You can also specify the target directory on your computer:

$ git clone https://github.com/user/recipe.git myrecipe

What just happened? Think of cloning as downloading the .git part to your computer. After downloading the .git part the branch pointed to by HEAD is automatically checked out.

Key Points