Version Control

Krok 1: GitLab & SSH Keys

V tomto kroku si vytvoríte účet na školskom GitLab serveri a potrebné SSH kľúče. Pomocou nich sa budete vedieť identifikovať, keď budete komunikovať so serverom git zo svojho pracovného prostredia.

Kľúče si vytvoríte pomocou príkazu ssh-keygen. Po jeho spustení nezadávajte žiadne ďalšie údaje! (zadávajte len Enter.) Konkrétne sa Vás nástroj bude pýtať na alternatívne umiestnenie vygenerovaných kľúčov a na bezpečnostnostnú frázu. Ukážka výstupu po spustení tohto príkazu môže byť nasledovná, pričom vstup od používateľa je zvýraznený tučne a riadok začínajúci znakom $ predstavuje príkazový riadok:

$ ssh-keygen
Generating public/private rsa key pair.
Enter file in which to save the key (/home/john/.ssh/id_rsa):
Created directory '/home/john/.ssh'.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /home/john/.ssh/id_rsa.
Your public key has been saved in /home/john/.ssh/id_rsa.pub.
The key fingerprint is:
eb:80:f3:1f:36:02:38:7c:7a:9d:64:e8:8c:6b:5a:eb john@machine
The key's randomart image is:
+---[RSA 2048]----+
|oo++ o=  .       |
|o++ oo=+o        |
|+oo..oo*..       |
|.  + .oo=.E      |
|  . . .oS+o.     |
|   . ... =o      |
|  . oo. . o      |
| o . .o+  ..     |
|..o.. ..o...     |
+----[SHA256]-----+

Vytvorené kľúče budú uložené v priečinku .ssh/ vo Vašom domovskom priečinku (čiže ~/.ssh/). Dôjde k vytvoreniu dvoch súborov:

• id_rsa.pub Váš verejný kľúč
• id_rsa Váš súkromný (privátny) kľúč

Verejný kľúč si najskôr zobrazte:

cat ~/.ssh/id_rsa.pub

Celý obsah súboru s kľúčom označte a skopírujte ho do schránky (skratka: Ctrl+Shift+C). Na stránku so zoznamom Vašich kľúčov sa dostanete postupne cez Edit Profile (vľavo hore) > SSH Keys alebo (ak ste prihlásený) rovno prejdite na odkaz git.kpi.fei.tuke.sk/-/user_settings/ssh_keys.

Krok 2: New Project

1. Kliknutím na uvedený odkaz budete v GitLab-e vyzvaní na autorizáciu aplikácie ZAP GitLab Classroom, ktorú pre Vás pripravil Manager.
2. Autorizovaním aplikácie budete presmerovaní na stránku vytvárania projektov ZAP 2024, kde si zvolíte skupinu podľa rozvrhovej jednotky (zobrazenej v tvare <skupina> - <deň> <čas>), ktorú v rámci predmetu navštevujete.
3. Kliknutím na tlačidlo pre vytvorenie projektu sa pre vás zobrazí link na váš novovytvorený projekt. Projekt taktiež nájdete medzi vašimi projektami v GitLab-e.

Postupnosť krokov, ktoré je potrebné vykonať na to, aby ste vytvorili počiatočnú verziu svojho projektu, sa nachádza priamo na stránke, ktorá sa zobrazila po procese vytvorenia projektu na serveri GitLab. Tieto kroky len prekopírujte a spustite ich vo Vašom prostredí z príkazového riadku.

Komunikácia so serverom môže byť nasledovná, pričom vstup od používateľa je zvýraznený tučne a riadok začínajúci znakom $ predstavuje príkazový riadok:

$ git config --global user.name "Your Name" (CHANGE YOUR NAME)
$ git config --global user.email "your.email@student.tuke.sk" (CHANGE YOUR EMAIL)
$ git clone git@git.kpi.fei.tuke.sk:zap-problemsets/2024/x0-den-cas/zap-2024-id.git (CHANGE YOUR ID NUMBER)
Cloning into 'zap-2024-id'...
warning: You appear to have cloned an empty repository.
Checking connectivity... done.
$ cd zap-2024-id (CHANGE YOUR ID NUMBER)
$ git switch -c main
$ touch README
$ git add README
$ git commit -m "add README"
[main (root-commit) 2859d11] add README
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 README
$ git push -u origin main
 __  ___ .______    __
|  |/  / |   _  \  |  | Katedra pocitacov a informatiky
|  '  /  |  |_)  | |  | Fakulta elektrotechniky a informatiky
|    <   |   ___/  |  | Technicka Univerzita v Kosiciach
|  .  \  |  |      |  |
|__|\__\ | _|      |__| Internal git repository

UNAUTHORIZED ACCESS TO THIS NETWORK DEVICE IS PROHIBITED.
You must have explicit permission to access or configure this
device. All activities performed on this device are logged and
violations of this policy will be prosecuted under all applicable
statutes plus all applicable civil rules for damages.
Counting objects: 3, done.
Writing objects: 100% (3/3), 230 bytes | 230.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To git.kpi.fei.tuke.sk:zap-problemsets/2024/x0-den-cas/zap-2024-id.git
 * [new branch]      main -> main
Branch 'main' set up to track remote branch 'main' from 'origin'.

Ak ste postupovali správne, po zobrazení stránky s projektom v GitLab-e a prejdení do časti Files sa Vám zobrazia súbory (v tomto prípade len súbor README), ktoré sú obsahom projektu.

git clone git@git.kpi.fei.tuke.sk:zap-problemsets/2024/x0-den-cas/zap-2024-id.git

kde git@git.kpi.fei.tuke.sk:zap-problemsets/2024/x0-den-cas/zap-2024-id.git predstavuje adresu projektu na GitLab-e.

git pull

git commit -am "sprava"

git push

Krok 3: Orientačný beh

V tomto kroku sa pokúsite vyriešiť prvú úlohu zadania PS1, ktoré Vás čaká. Kompletné znenie zadania nájdete na tejto stránke.

mkdir ps1
cd ps1

touch task_1.c

Krok 4: Project Testing

Ak spravíte vo svojom projekte zmenu, jeho aktuálny stav si viete zobraziť pomocou príkazu:

git status

Po vytvorení programu task_1.c môže výstup tohto príkazu vyzerať nasledovne, pričom vstup od používateľa je zvýraznený tučne a riadok začínajúci znakom $ predstavuje príkazový riadok:

$ git status
On branch main
Your branch is up-to-date with 'origin/main'.

Untracked files:
  (use "git add ..." to include in what will be committed)

  ps1/task_1.c

nothing added to commit but untracked files present (use "git add" to track)

Ak chcete do projektu pridať súbor task_1.c, použite príkaz:

git add ps1/task_1.c

Na základe požiadaviek PS1 je potrebné modifikovať súbor README nasledovne:

GROUP : C1

Na základe požiadaviek PS1 je potrebné vytvoriť aj súbory ps1/task_2.c ... ps1/task_7.c. Na vytvorenie prázdneho súboru použite príkaz:

touch ps1/task_2.c

Ak si overíte Vaše zmeny, výstup môže vyzerať nasledovne, pričom vstup od používateľa je zvýraznený tučne a riadok začínajúci znakom $ predstavuje príkazový riadok:

$ git status
On branch main
Your branch is up to date with 'origin/main'.

Changes to be committed:
  (use "git reset HEAD ..." to unstage)

	new file:   ps1/task_1.c

Changes not staged for commit:
  (use "git add ..." to update what will be committed)
  (use "git checkout -- ..." to discard changes in working directory)

	modified:   README

Untracked files:
  (use "git add ..." to include in what will be committed)

	ps1/task_2.c
	ps1/task_3.c
	ps1/task_4.c
	ps1/task_5.c
	ps1/task_6.c
	ps1/task_7.c

Odosielanie projektu na server sa vykonáva v dvoch fázach:

• Najskôr pomocou príkazu git commit -am "message" odošlete vykonané zmeny do lokálneho repozitára. Pri commitovaní predstavuje prepínač -am "message" odoslanie všetkých vykonaných zmien a zároveň bude táto zmena označená správou message.
• Následne pomocou príkazu git push odošlete všetky vykonané zmeny na vzdialený git server.

git log

Príklad uvedenej komunikácie pomocou príkazov git commit a git push môže vyzerať nasledovne:

$ git add ps1/task_2.c ps1/task_3.c ps1/task_4.c ps1/task_5.c ps1/task_6.c ps1/task_7.c
$ git commit -am "inicializacia projektu"
[main 4d97a92] inicializacia projektu
 4 files changed, 2 insertions(+)
 create mode 100644 ps1/README
 create mode 100644 ps1/task_1.c
 create mode 100644 ps1/task_2.c
$ git push
 __  ___ .______    __
|  |/  / |   _  \  |  |   Katedra pocitacov a informatiky
|  '  /  |  |_)  | |  |   Fakulta elektrotechniky a informatiky
|    <   |   ___/  |  |   Technicka Univerzita v Kosiciach
|  .  \  |  |      |  |
|__|\__\ | _|      |__|   Internal git repository

UNAUTHORIZED ACCESS TO THIS NETWORK DEVICE IS PROHIBITED.
You must have explicit permission to access or configure this
device. All activities performed on this device are logged and
violations of this policy will be prosecuted under all applicable
statutes plus all applicable civil rules for damages.

Counting objects: 5, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (5/5), 414 bytes | 414.00 KiB/s, done.
Total 5 (delta 0), reused 0 (delta 0)
To git.kpi.fei.tuke.sk:zap-problemsets/2024/x0-den-cas/zap-2024-id.git
   2859d11..4d97a92  main -> main

Po úspešnom odoslaní projektu skontrolujte jeho stav na stránke projektu v GitLab-e.

• Príkaz git commit je možné použiť viackrát - zmeny sa odosielajú len do lokálneho repozitáru. S výhodou sa táto vlastnosť dá použiť pri práci bez sieťového pripojenia.
• Parametrom commit-u je správa, ktorú je potrebné zadať, a ktorá sa zobrazí pri commit-och v GitLab-e, prípadne po zadaní príkazu git log.
• Po spustení automatického testovania Vám príde na Váš školský email správa s adresou, na ktorej si môžete pozrieť výsledky tohto testovania. Všetky ďalšie testy sa budú nachádzať na rovnakej adrese.