remotes_handouts.tex 4.05 KB
Newer Older
Vermaat's avatar
Vermaat committed
1 2
\documentclass{article}

Laros's avatar
Laros committed
3
\providecommand{\handoutsTitle}{Git and remote repositories}
Vermaat's avatar
Vermaat committed
4

Laros's avatar
Laros committed
5
\usepackage{handouts}
6 7 8 9 10 11

\usepackage{multicol}
\usepackage{enumitem}
\usepackage{xcolor}
\usepackage{graphicx}

Laros's avatar
Laros committed
12
\input{../shared/shared}
Vermaat's avatar
Vermaat committed
13

Laros's avatar
Laros committed
14 15
\begin{document}
\makeHeader
Vermaat's avatar
Vermaat committed
16

Laros's avatar
Laros committed
17
\subsubsection*{Some notes about using GitLab}
18 19 20 21 22 23 24
Please take the following into account with respect to our GitLab server:
\begin{itemize}
  \item You can login to GitLab using your LUMC account.
  \item If you don't have an LUMC account, ask us to create a GitLab account
    for you and select {\em Standard} instead of {\em LDAP} on the login
    page.
\end{itemize}
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

It is convenient to set up an ssh key on GitLab. Make one as follows (you can leave all fields blank):
\begin{lstlisting}
  $ ssh-keygen
  Enter file in which to save the key (/home/<username>/.ssh/id_rsa):
  Enter passphrase (empty for no passphrase):
  Enter same passphrase again:
\end{lstlisting}
\medskip

Open \url{https://git.lumc.nl} in your browser and log in.
\medskip

Click on your avatar (top-right corner), choose ``Settings'', and then go the ``SSH Keys'' page.
\medskip

Copy your ssh key, retrieved with the following \lstinline{cat} command, and paste it in the ``Key'' field:
\begin{lstlisting}
  $ cat ~/.ssh/id_rsa.pub
\end{lstlisting}
\medskip

Give your key a title (e.g., ``Course machine'') and press the ``Add key'' button.
48 49
\bigskip

Laros's avatar
Laros committed
50
\subsubsection*{Add your repository to GitLab}
Vermaat's avatar
Vermaat committed
51 52 53 54 55
\begin{quote}
(If you don't have a repository on your local machine from the previous
practical, create one now with at least one commit.)
\end{quote}

Vermaat's avatar
Vermaat committed
56 57 58
Now you have a nice repository, of course you want to share it on GitLab.
\bigskip

Laros's avatar
Laros committed
59
Go to GitLab (\url{https://git.lumc.nl}) and create a new project (use the
Vermaat's avatar
Vermaat committed
60
same name you used to store your repository locally).
Vermaat's avatar
Vermaat committed
61 62

\begin{itemize}
Vermaat's avatar
Vermaat committed
63
  \item \emph{Question:} What is the repository URL for your new project?
Vermaat's avatar
Vermaat committed
64 65 66
\end{itemize}
\bigskip

67
Add the GitLab repository as a remote to your local repository.
Vermaat's avatar
Vermaat committed
68 69
\bigskip

Vermaat's avatar
Vermaat committed
70
Push your commits to GitLab.
Vermaat's avatar
Vermaat committed
71 72

\begin{itemize}
Vermaat's avatar
Vermaat committed
73 74
  \item \emph{Question:} Can you see your repository content in the GitLab web
    interface?
Vermaat's avatar
Vermaat committed
75
\end{itemize}
76
\bigskip
Vermaat's avatar
Vermaat committed
77

Laros's avatar
Laros committed
78 79
\emph{Hint:} Use \lstinline{git push} once with the \lstinline{-u} flag so you
can use the \lstinline{git push} / \lstinline{git pull} shortcuts.
Vermaat's avatar
Vermaat committed
80 81
\bigskip

Laros's avatar
Laros committed
82
\subsubsection*{More synchronisation}
Vermaat's avatar
Vermaat committed
83 84
Look for a way to edit a file directly from the GitLab web interface (in your
browser) and do this at least once.
Vermaat's avatar
Vermaat committed
85 86
\bigskip

Vermaat's avatar
Vermaat committed
87 88
Update your local copy of the file with the change you just made (by fetching
and merging).
Vermaat's avatar
Vermaat committed
89 90
\bigskip

Vermaat's avatar
Vermaat committed
91 92 93
Now make another commit locally and push it to the GitLab server. Verify that
all these changes are now present both on your local machine and on the GitLab
server.
Vermaat's avatar
Vermaat committed
94

95 96 97
\subsubsection*{Collaboration}
In this practical, you'll work with both your repository and with the repository your neighbour created
during the previous practical. We'll refer to this repository as {\bf N}, and
98
to your own repository from the previous practical as {\bf Y}. Note that by now both repositories should have a
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
corresponding GitLab project (a remote repository).
\bigskip

Make sure that your GitLab project \textbf{Y} is private and add your colleague as a member to it as \textbf{Guest}.
\bigskip

Try to \textbf{clone} his or her repository to your local machine. Make sure to do this in a separate directory.

\begin{itemize}
  \item \emph{Question:} Was the cloning successful? Try to identify why.
\end{itemize}

Change the role of your neighbour from \textbf{Guest} to \textbf{Developer} and try to \textbf{clone} his repository again once your neighbour made you a \textbf{Developer}.
\bigskip

Edit locally a file from your neighbour \textbf{N} directory, stage it, commit it, and try to \textbf{push}.

\begin{itemize}
  \item \emph{Question:} Were you able to push? Try to identify why.
\end{itemize}

Change your neighbour's role in your GitLab project from \textbf{Developer} to \textbf{Master}.
\bigskip

After your neighbour upgraded your role to \textbf{Master} try to push again your changes to his GitLab repository.
\medskip

Inspect the commit graph on GitLab.

Vermaat's avatar
Vermaat committed
128
\end{document}