build details

Show: section status errors & todos local changes recent changes last change in-page changes feedback controls

Github

Modified 2019-09-22 by Andrea Censi

How to sign up to Github and use its basic functions.

This chapter describes how to create a Github account and setup SSH on the robot and on the laptop.

Create a Github account

Modified 2019-09-22 by Andrea Censi

Our example account is the following:

Github name: greta-p
E-mail: greta-p@duckietown.com

Create a Github account (Figure 2.1).

signing up

Go to your inbox and verify the email.

Add a public key to Github

Modified 2019-09-22 by Andrea Censi

You will do this procedure twice: once for the public key created on the laptop, and later with the public key created on the robot.

A public/private keypair already created and configured. This procedure is explained in (unknown ref software_reference/howto-create-key-pair)

previous warning next (47 of 57) index
warning
I will ignore this because it is an external link. 

 > I do not know what is indicated by the link '#software_reference/howto-create-key-pair'.

Location not known more precisely.

Created by function n/a in module n/a.
.

You can access Github using the key provided.

comment

Since I am not as familiar with Linux an VIM it would have been great to say how we can get access to the public key: sudo vim /home/username/.ssh/username@host name.pub and than copy it and add it on github SL

Go to settings (Figure 2.2).

Add the public key that you created:

To check that all of this works, use the command

$ ssh -T git@github.com

The command tries to connect to Github using the private keys that you specified. This is the expected output:

Warning: Permanently added the RSA host key for IP address 'ip address' to the list of known hosts.
Hi username! You've successfully authenticated, but GitHub does not provide shell access.

If you don’t see the greeting, stop.

hub

Modified 2019-09-22 by Andrea Censi

hub is a command line utility written by Github.

It can be used as a substitute of git, in the sense that any command like git xxx can be rewritten as hub xxx. In addition, it provides several functions unique to Github, like creating pull requests.

Installation

Modified 2019-09-22 by Andrea Censi

Install hub using the instructions.

Jump to project page

Modified 2019-09-22 by Andrea Censi

Open the project page using:

$ hub browse

Creating pull requests

Modified 2019-09-22 by Andrea Censi

You can create a pull request using:

$ hub pull-request -m "description"