This is an old revision of the document!
student@uso:~$ cd /home/student/uso-lab student@uso:~$ git stash student@uso:~$ git pull student@uso:~$ git stash pop Updating d192801..bb8cbe7 Fast-forward labs/04-appdev/support/simple-make/Makefile | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
Vor fi cazuri când vom strica o versiune a codului și vom avea nevoie să revenim la o versiune corectă, caz în care un istoric de versiuni ne-ar fi de folos. Vom putea să lucrăm la un proiect de pe un alt sistem, în afară de al nostru, sau vom vrea să cerem feedback pe codul scris de noi.
Când vorbim despre un proiect software vrem să avem dezvoltatori, oameni care să lucreze împreună cu noi la proiect. Dezvoltatorii au nevoie de acces la codul sursă al proiectului software la care lucrăm. După ce le dăm acces, vrem ca fiecare dezvoltator să știe la ce a lucrat și la ce lucrează ceilalți; ca să nu se suprapună, ca să ajute și ca să ofere feedback.
Pentru a putea rezolva problemele de sincronizare între doi sau mai mulți colegi de echipă care lucrează la același proiect, ne ajută să avem un sistem de versionare a codului, adică să avem un istoric de modificări. Fiecare modificare înseamnă o nouă versiune a proiectului; avem astfel o listă de versiuni gestionată de sistemul de versionare a codului. Pe lângă rezolvarea problemelor de sincronizare, versionarea codului aduce și alte avantaje cum ar fi revenirea la o versiune mai veche a proiectului, găsirea rapidă a autorului unei secvențe de cod sau, pur și simplu, organizarea unui proiect.
Git este un sistem de management și versionare a codului sursă care permite lucrul eficient la un proiect software.
GitHub este o platformă online, bazată pe Git, pe care dezvoltatorii o pot folosi pentru a stoca și versiona codul lor sursă. Git este utilitarul folosit, iar GitHub este serverul și aplicația web pe care rulează acesta, locul în care păstrăm repository-ul remote.
Similar cu GitHub există și alte platforme precum Bitbucket sau GitLab. Comenzile pe care le vom studia se aplică pentru toate platformele care folosesc Git, doar interfața grafică diferă.
În această carte vom folosi GitHub ca suport. În mare parte, acesta nu diferă foarte mult de alte platforme.
Înainte de toate, ne asigurăm că avem cont pe GitHub. Dacă aveți deja un cont pe GitHub, puteți trece la subsecțiunea următoare: Pregătirea inițială a mediului Git
.
Dacă nu aveți cont, intrați pe GitHub. Pagina de pornire va arăta similar cu cea din imaginea de mai jos.
Introduceți un nume de utilizator username, adresa voastră de e-mail și o parolă sigură pentru cont. Pentru validarea contului, accesați-vă căsuța de e-mail. Acolo veți găsi un e-mail în care vi se explică cum se poate valida noul cont creat. Verificați și căsuța spam în caz că nu ați primit nimic în inbox
GitHub Student Pack
GitHub oferă studenților numeroase beneficii care în mod normal sunt contra cost (plătite). Găsiți mai multe detalii pe site-ul oficial.
Ca să utilizăm Git, facem în primă fază niște pași de configurare. Adică vom configura numele și e-mail-ul nostru, ca mai jos:
student@uso:~$ git config --global user.name "Prenume Nume" student@uso:~$ git config --global user.email "adresa_de_email@example.com"
În listingul de mai sus “Prenume Nume” și ”adresa_de_email@example.com” sunt placeholdere. Le înlocuiți cu datele voastre. De exemplu, pentru autorul acestei secțiuni, comenzile rulate sunt:
student@uso:~$ git config --global user.name "Liza Babu" student@uso:~$ git config --global user.email "lizababu@example.com"
Pentru a lucra la un proiect software, creăm un repository software. Vom crea unul pe GitHub, unul local, după care le vom interconecta.
Repository software
Proiectul este stocat într-un repository software. Repository-ul conține fișierele proiectului: codul sursă, fișiere de configurare. De obicei acesta vine însoțit și de un fișier README.md în care se găsesc informații despre proiect: care este scopul proiectului, cum se compilează, pe ce platforme rulează.
Repository-urile sunt de două tipuri: locale și remote. Acestea pot fi interconectate și să refere de fapt același proiect. Repository-ul local este cel pe care îl avem la noi pe calculator, pe când cel remote este unul stocat pe un server (în cazul nostru GitHub). Este doar o diferență de perspectivă între cele două, ele nu diferă din punct de vedere tehnic. De obicei, într-un proiect Git / GitHub există un repository central (remote) și mai multe repository-uri secundare (locale), câte unul pentru fiecare dezvoltator din echipa proiectului.
Printre cele mai importante operații cu un repository sunt: init, fork, clone. Vom detalia aceste operații când le vom folosi în acest capitol.
Ne autentificăm pe GitHub. Urmărim pașii prezentați în imaginea de mai jos și explicați imediat după.
Your profile
pentru a merge pe profilul nostru. Aici este locul în care vom putea vedea contribuțiile noastre pe GitHub. În partea de sus a ecranului vom vedea un meniu orizonatal care conține 4 opțiuni: Overview
, Repositories
, Projects
și Packages
.Repositories
. Acum vom vedea întreaga listă de repository-uri pe care le avem. Pentru a crea unul nou, apăsăm pe butonul verde din dreapta sus pe care scrie New
.array-sorting-algorithms
. Descrierea proiectului este opțională, dar e recomandat să o adăugăm pentru a fi ușor de înțeles pentru cei care vor ajunge la proiectul nostru.Create repository
. Vor apărea câteva instrucțiuni pentru crearea unui repository local nou și conectarea celui nou cu cel remote. Acest lucru este acoperit în secțiunile următoare.
Acum avem un repository creat remote, pe GitHub, numit array-sorting-algorithms
.
Creăm un director din ierarhia de fișiere în care vom inițializa repository-ul Git.
În acest tutorial creăm directorul array-sorting-algorithms
în directorul home (adică /home/student
sau ~
), folosind comenzile de mai jos:
student@uso:~$ pwd /home/student student@uso:~$ mkdir array-sorting-algorithms student@uso:~$ cd array-sorting-algorithms student@uso:~/array-sorting-algorithms$ git init Initialized empty Git repository in /home/student/array-sorting-algorithms/.git/ student@uso:~/array-sorting-algorithms$ ls -a ./ ../ .git/
Mai sus am inițializat repository-ul local prin comanda git init
, dată în directorul ales (array-sorting-algorithms
) din directorul home al utilizatorului student (/home/student
).
Acum avem un repository creat local, numit array-sorting-algorithms
.
Init
Operația init este una locală și are rolul de a inițializa un repository gol, local. Inițializarea repository-ului local înseamnă crearea, în directorul ales, a mediului pentru a putea lucra la un proiect software versionat Git. Această operare duce la crearea unui director numit .git
în care se vor ține ulterior date suplimentare despre repository, numite metadatele repository-ului.
Am folosit opțiunea -a
(ls -a
) pentru a afișa și fișierele și directoarele ascunse. Directorul .git
este un director ascuns.
Am creat până în acest moment un repository local și unul remote. Trebuie să le interconectăm pentru a lucra cu ele.
În cazul în care suntem mai mulți membri în echipă, fiecare membru va conecta repository-ul său local, la repository-ul remote. Pentru conectarea celor două repository-uri folosim comanda de mai jos, dată în directorul unde este repository-ul local Git (în cazul nostru /home/student/array-sorting-algorithms
):
student@uso:~/array-sorting-algorithms$ git remote add origin https://github.com/username/array-sorting-algorithms.git
În comanda de mai sus username
este numele utilizatorului nostru de pe GitHub. De exemplu, pentru autorul acestui capitol, username
se înlocuiește cu lizababu
.
Conectarea celor două repository-uri înseamnă setarea repository-ului origin
, adică repository-ului remote la care se conectează cel local.
Imaginea de mai jos arată cum arată cum se contectează repository-urile remote și local. Sincronizarea lor se face prin intermediul operațiilor push și pull care sunt prezentate pe parcursul secțiunii Primele commituri
.
Odată creat repository-ul, putem să începem să lucrăm la proiect.
Lucrul la proiect înseamnă să adăugăm și să ștergem fișiere sau să modificăm fișiere existente. De obicei este vorba de fișiere text (human-readable), cel mai des fișiere cod sursă1). Vrem să salvăm aceste adăugări și modificări; apoi să salvăm din nou alte modificări; și tot așa.
Salvarea acestor modificări înseamnă crearea unui commit în repository.
Același lucru îl fac și ceilalți colegi care lucrează la același proiect. Fiecare commit împachetează un set de adăugări și modificări realizate de un dezvoltator al proiectului. Având commiturile în repository putem să gestionăm mai ușor proiectul, adică:
Git se ocupă de păstrarea și gestiunea istoricului repository-ului nostru prin păstrarea listei de commituri făcute. Adică Git păstrează un istoric de versiuni al proiectului.
Când facem un commit, acesta va fi reținut în repository-ul Git local, nu și în repository-ul Git remote.
Fără a actualiza și repository-ul remote, ceilalți colegi nu vor putea vedea schimbările făcute de noi. Vrem, așadar, ca modificările făcute local să se găsească și remote. Adică să publicăm commiturile din repository-ul local în repository-ul remote. Realizăm publicarea prin operația push.
Vom vedea în următoarele secțiuni care sunt pașii pentru a crea un commit și pentru a-l publica.
În următoarele secțiuni vom lucra în repository-ul array-sorting-algorithms
creat în secțiunea Introducere în Git și GitHub
. Vom crea, pas cu pas, un proiect software scris în limbajul de programare C, care conține mai mulți algoritmi de sortare a unui vector de elemente întregi.
Punctual, în această secțiune, vom crea fișierul README
al proiectului și scheletul de cod pentru algoritmii de sortare Bubble Sort, Merge Sort și Radix Sort. Vom crea commituri în repository-ul local pentru fiecare schimbare, după care vom publica commiturile astfel încât schimbările să fie vizibile și pe GitHub, în repository-ul remote.
Reamintire
O bună practică, prezentă în majoritatea proiectelor software, este să adăugăm un fișier README
în care se află informații despre un proiect. Spre exemplu, în README
se află informații despre ce funcționalități are proiectul nostru, cum se compilează un proiect, cum se rulează, pe ce tip de platforme poate fi rulat etc.
Un fișier README
este un fișier text. Îl putem crea și îi putem adăuga titlul Sorting Algorithms for Beginners
folosind un editor sau, mai simplu și mai direct, folosind comanda de mai jos:
student@uso:~/array-sorting-algorithms$ echo "# Sorting Algorithms for Beginners" > README.md student@uso:~/array-sorting-algorithms$ ls -a ./ ../ .git/ README.md
#
din fața textului Sorting Algorithms for Beginners
are rol de a formata textul sub formă de titlu. Nu intrăm în mai multe detalii aici pentru că nu face obiectul cărții.
Folosim extensia .md
care semnalează un fișier de tip Markdown. Facem acest lucru deoarece pe GitHub fișierele README
sunt afișate în format Markdown. Acest format este simplu de înțeles, însă nu face obiectul acestei cărți, deci nu vom insista pe înțelegerea lui.
Acum avem în repository un nou fișier: README.md
. Vrem să reținem acest lucru în repository prin crearea unui commit, primul.
Pașii creării unui commit sunt următorii:
Detaliem acești pași în continuare.
Prin starea repository-ului înțelegem forma la care am adus proiectul prin modificările noastre. Aceasta include ce fișiere am creat, modificat sau șters de la ultimul commit. Ne interesează întotdeauna starea repository-ului pe care lucrăm.
Pentru a verifica starea repository-ului folosim comanda git status
:
student@uso:~/array-sorting-algorithms$ git status On branch master No commits yet Untracked files: (use "git add <file>..." to include in what will be committed) README.md
Prima linie afișată On branch master
se referă la branch-ul master
local. Vom discuta în secțiunea Lucrul pe branch-uri
despre branch-uri.
A doua linie afișată No commits yet
ne spune că nu am făcut până acum niciun commit, adică am pornit de la un repository gol.
În ultima parte a outputului se află o listă de fișiere untracked
, adică lista fișierelor pe care Git le vede ca nou adăugate în repository-ul curent, dar pe care nu le monitorizează încă. Acest lucru înseamnă că, deocamdată, orice modificare vom face asupra acestor fișiere nu va fi urmărită (tracked) de Git. În cazul nostru, fișierul aflat în starea untracked este README.md
.
Un commit va conține o listă de modificări: fișiere adăugate, fișiere șterse, conținut modificat. Un pas intermediar în crearea unui commit este pregătirea modificărilor ce vor fi parte din commit. Acest pas de pregătire înseamnă să adăugăm (add) aceste modificări într-o zonă de lucru pentru Git, numită staging area.
În cazul nostru, vrem să adăugăm fișierul README.md
în staging area. Facem acest lucru folosind comanda git add
:
student@uso:~/array-sorting-algorithms$ git add README.md
Verificăm ce s-a schimbat în urma adăugării fișierului README.md
în staging folosind comanda git status
:
student@uso:~/array-sorting-algorithms$ git status On branch master No commits yet Changes to be committed: (use "git rm --cached <file>..." to unstage) new file: README.md
Primele 2 mesaje afișate au rămas neschimbate. Partea interesantă apare la ultima parte a outputului. Vedem că mesajul a devenit Changes to be commited
. Acest lucru înseamnă că acum Git urmărește noile modificări și așteaptă ca modificările să fie adunate într-un commit.
Acum vrem ca modificările de mai sus să ajungă în repository. Pentru aceasta creăm un commit folosind comanda git commit
:
student@uso:~/array-sorting-algorithms$ git commit -m "Add README file" [master (root-commit) b2a590a] Add README.md 1 file changed, 1 insertion(+) create mode 100644 README.md student@uso:~/array-sorting-algorithms$ git status On branch master nothing to commit, working tree clean
Am folosit descrierea Add README file
la comanda git commit
drept mesaj de commit2). Aceasta este o descriere succintă a modificărilor făcute prin acest commit.
În continuare vom adăuga scheletul de cod pentru algoritmul Bubble Sort în repository. Vom crea un nou fișier cod sursă C bubble-sort.c
și vom scrie în el scheletul de cod pentru algoritm. Vom crea un nou commit care va conține fișierul bubble-sort.c
. Pentru aceasta vom folosi un editor, precum nano, ca în imaginea de mai jos:
Conținutul fișierului bubble-sort.c
este:
#include <stdio.h> static void sort(void) { // TODO: add bubble sort algorithm here } int main() { return 0; }
Mai sus am creat un commit cu fișierul bubble-sort.c
urmând pași similari cu cei din secțiunea Crearea primului commit
:
student@uso:~/array-sorting-algorithms$ git status (...) student@uso:~/array-sorting-algorithms$ git add bubble-sort.c student@uso:~/array-sorting-algorithms$ git status (...) student@uso:~/array-sorting-algorithms$ git commit -m "Add Bubble Sort skeleton" (...)
radix-sort.c
cu următorul conținut:#include <stdio.h> static void sort(void) { // TODO: add radix sort algorithm here } int main() { return 0; }
radix-sort.c
. Folosiți următorul mesaj de commit: Add Radix Sort algorithm skeleton
.git log
. Detaliem outputul comenzii git log
în subsecțiunea Verificarea istoricului de commituri
.merge-sort.c
cu următorul conținut:#include <stdio.h> static void sort(void) { // TODO: add merge sort algorithm here } int main() { return 0; }
merge-sort.c
. Folosiți următorul mesaj de commit: Add Merge Sort algorithm skeleton
.git log
.
Până acum am creat commituri care conțineau un fișier nou creat. În această secțiune vom modifica conțintului fișierului README.md
și vom crea un nou commit, așa cum apare în comenzile de mai jos:
student@uso:~/array-sorting-algorithms$ echo "We implement 3 sorting algorithms for integer arrays." >> README.md student@uso:~/array-sorting-algorithms$ git status On branch master Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git checkout -- <file>..." to discard changes in working directory) modified: README.md no changes added to commit (use "git add" and/or "git commit -a") student@uso:~/array-sorting-algorithms$ git add README.md student@uso:~/array-sorting-algorithms$ git status On branch master Changes to be committed: (use "git reset HEAD <file>..." to unstage) modified: README.md student@uso:~/array-sorting-algorithms$ git commit -m "Update README with project explanation" [master 247b87f] Update README with project explanation 1 file changed, 1 insertion(+)
Spre deosebire de secțiunea Crearea unui nou commit
, unde comanda git status
arăta că fișierul modificat (în acel caz, bubble-sort.c
) este nou (new file), acum comanda git status
arată că fișierul modificat (în acest caz, README.md
) a fost modificat (modified). Deși apare această diferență în outputul comenzii git status
, pașii pentru crearea unui commit care conține un fișier nou sau unul deja existent (dar modificat) sunt aceiași.
README.md
în # Sorting Algorithm for Integer Arrays
.README.md
. Folosiți următorul mesaj de commit: Update README title
.
La orice pas al dezvoltării proiectului vrem să știm în ce stadiu ne aflăm ca să ne dăm seama ce am făcut deja și ce trebuie să mai facem în continuare. De aceea folosim un sistem de versionare a codului, în cazul nostru Git
. Verificăm istoricul commiturilor folosind comanda git log
:
student@uso:~/array-sorting-algorithms$ git log commit 66b7c5fabb93b521326e6cd9ff219a06a3aec064 (HEAD -> master) Author: Liza Babu <lizababu@example.com> Date: Thu Sep 24 10:40:06 2020 -0700 Update README title commit 247b87f3f317816a204c4512f6fd9914527a03ad Author: Liza Babu <lizababu@example.com> Date: Thu Sep 24 09:50:30 2020 -0700 Update README with project explanation commit 3c835b0d8e7fc88ef45dfd3681867c21b75ed588 Author: Liza Babu <lizababu@example.com> Date: Thu Sep 24 09:45:13 2020 -0700 Add Merge Sort algotihm skeleton commit b92a52c0fc5d66dce4b2562114cc84ea326b2763 Author: Liza Babu <lizababu@example.com> Date: Thu Sep 24 09:44:36 2020 -0700 Add Radix Sort algotihm skeleton commit f65a7fbe8bbe1b36ba5c8e16607456a879bfb6fa Author: Liza Babu <lizababu@example.com> Date: Thu Sep 24 09:21:49 2020 -0700 Add Bubble Sort algorithm skeleton commit b2a590a8637f1eab96e557334dbd4be14bf95833 Author: Liza Babu <lizababu@example.com> Date: Thu Sep 24 09:09:51 2020 -0700 Add README file
Navigați prin outputul comenzii git log
prin intermediul săgeților sus/jos. Apăsați tasta q când ați terminat de inspectat.
În cazul autorului acestui capitol, numele, prenumele și emailul sunt Liza Babu <lizababu@example.com>
, așa cum apare în exemplul de mai sus: Author: Liza Babu <lizababu@example.com>
.
Fiecare commit este identificat unic printr-un cod, numit cod hash3). Discutăm în continuare despre ultimul commit din listă. Acesta are codul hash 66b7c5fabb93b521326e6cd9ff219a06a3aec064
și mesajul de commit Update README title
.
Acum vedem că repository-ul indică spre acest nou commit. Ne dăm seama de acest lucru pentru că HEAD
se află în dreptul commitului tocmai făcut. HEAD
ne indică starea repository-ului, adică ne arată care este ultimul commit pe care l-am făcut în repository.
Vrem să publicăm pe GitHub toate schimbările făcute, pentru a fi vizibile și altor colaboratori ai proiectului. Publicăm commitul folosind comanda git push
:
git push
aveți nevoie de un token de acces pe care îl veți folosi în locul parolei. Urmăriți tutorialul de aici pentru crearea unui token.
Atenție! Rețineți token-ul deoarece acesta este afișat o singură dată.
student@uso:~/array-sorting-algorithms$ git push origin master Counting objects: 18, done. Delta compression using up to 2 threads. Compressing objects: 100% (16/16), done. Writing objects: 100% (18/18), 1.95 KiB | 222.00 KiB/s, done. Total 18 (delta 3), reused 0 (delta 0) remote: Resolving deltas: 100% (3/3), done. To https://github.com/lizababu/array-sorting-algorithms.git * [new branch] master -> master
În felul acesta commiturile locale au fost publicate (“împinse”, push) din repository-ul local în repository-ul remote identificat de origin
. Commiturile locale se aflau pe branch-ul master din repository-ul local și au fost publicate tot în branch-ul master al repository-ului origin. Vorbim despre branch-uri în secțiunea Lucrul pe branch-uri
.
Ca să verificăm publicarea commiturilor, folosim interfața GitHub:
În lucrul cu Git / GitHub, există bune practici pe care recomandăm să le urmăm.
Atunci când ne apucăm de lucru vrem să sincronizăm repository-ul local cu cel remote. Pot apărea diferențe în momentul în care altcineva a publicat schimbări remote după ce am făcut noi ultima sincronizare. În momentul în care cineva a publicat modificări asupra unei secvențe de cod pe care și noi o modificăm, apar conflicte. Conflictele trebuie rezolvate.
Facem acest lucru prin operația pull
, care aduce local toate modificările și încearcă să rezolve conflicetele în mod automat4). Dacă rezolvarea conflictelor nu se poate face automat, trebuie să ne ocupăm de acest pas.
pull
nu a fost necesară.