Setting Up and Using Git and Github

Overview

Teaching: 5 min
Exercises: 0 min
Questions
  • How do I get a Github account?

  • How do I get set up to use Git on the COLA Computers?

Objectives
  • Configure git

  • Understand the meaning of the --global configuration flag.

GitHub Account

If you have a GitHub account already, make sure you can find it on the web and can login to it.

Note that as of September 2021, GitHub is upgrading its security requirements. Your old account may require updating to continue to work. Please see this link for options.

These include the following choices:

  1. Add existing key to ssh-agent and then changing https access to ssh.
  2. Remaining with https access but creating a personal access token (PAT) for https authentication

There are also instructions for switching a repo’s authentication method between https and ssh.

If you do not have a GitHub account, create one:

  1. Go to https://github.com, choose a username, email address to use, and password to sign up to Github.
  2. Follow the rest of the instrucitons to create your account.
  3. Choose the free service - it is more than adequate for what we will do.

See the links above regarding “security options” for those choices - SSH keys work just like you have set up to log into COLA computers. PATs work like passwords.

Git on Unix

Git is a command line version control system that is available by default on most Unix/Linux, Mac computers and can be easily installed for Windows (https://gitforwindows.org/). You can use it on your own computer. In this class, we will be using it on the COLA computers where it is already installed.

When we use Git for the first time, we need to configure a few things. Below are a few examples of configurations we will set as we get started with Git:

On a command line, Git commands are written as git verb options, where verb is what we actually want to do and options is additional optional information which may be needed for the verb.

First, we can check to see how these options are set by default on the COLA Computers:

$ git config --list

Here is how Dracula sets up his new laptop:

$ git config --global user.name "Vlad Dracula"
$ git config --global user.email "vlad@tran.sylvan.ia"

Please use your own name and email address instead of Dracula’s. This user name and email will be associated with your subsequent Git activity, which means that any changes pushed to GitHub will include this information.

For these lessons, we will be interacting with GitHub and so the email address used should be the same as the one used when setting up your GitHub account. If you are concerned about privacy, please review GitHub’s instructions for keeping your email address private.

Keeping your email private

If you elect to use a private email address with GitHub, then use that same email address for the user.email value, e.g. username@users.noreply.github.com replacing username with your GitHub one.

These commands we just ran above only need to be run once: the flag --global tells Git to use the settings for every project, in your user account, on this computer.

You can check your settings at any time:

$ git config --list

You can change your configuration anytime you want using the same commands.

Git Help and Manual

Always remember that if you forget a git command, you can access the list of commands by using -h and access the Git manual by using --help :

$ git config -h
$ git config --help

While viewing the manual, remember the : is a prompt waiting for commands and you can press Q to exit the manual.

Key Points

  • Use git config with the --global option to configure a user name and email address