Git

Sistema de control de versions o VCS iniciat per l'equip de desenvolupament del Kernel de Linux el 2007. Actualment és el sistema més utilitzat esdevenint un estàndard hegemònic.

Referències:

• VCS : teoria sobre els sistemes de control de versions.
• https://git-scm.com la web oficial de Git.
• Xuleta de comandes Git: apunts antics.
• W3Docs.com secció Git : trucs variats i documentació.
• Proveidors de repositoris gratuïts:
  • https://github.com
  • https://gitlab.com : Gitlab té el servei de repositoris (SaaS) però també pots descarregar el software en local i muntar el teu propi servidor.
  • Documentació del CLI de Gitlab : github accessible via command line.
• Uns quants trucs imprescindibles de Git per quan hem fet alguna gamba.

Abans d'entrar en pànic feu commit i push!

Videotutorial Git + Apache

Videotutorial per iniciar-se amb Git i Apache:

Comandes bàsiques

I tingueu en compte que hi ha alguns arxius importants:

• .git/config: arxiu amb les configuracions de correspondència dels repositoris remots i branques.
• .gitignore: arxiu que indica quins arxius o carpetes NO s'han de pujar al fer git add . Molt útil per arxius de producció amb contrasenyes i similars.

Primera pràctica amb Git

La situació més habitual és la de clonar un repositori existent, contribuir-hi afegint arxius o modificacions, i tornant a pujar els canvis.

Clonarem el projecte Welcome del grup de DAW del Esteve Terradas, on surten les fotos dels alumnes de desenvolupament que passen per l'institut, visualitzarem la web i afegirem la nostra foto i el nostre profile (arxiu HTML que es mostrarà quan cliquem sobre la foto).

Si ets alumne de l'Esteve Terradas pots seguir el tutorial tal qual, demanant al professor que t'inclogui a l'equip de treball del cicle, donant-li el teu nickname del Github.

Si no ets alumne del Terradas, pots clonar el projecte Welcome al teu compte de Github fent un FORK (busca el botó «Fork» a dalt a la dreta de la pàgina del projecte). Llavors canvia el git clone de l'inici i canvia l'adreça per la de la teva còpia que has fet (hauria de ser algo com https://github.com/elmeusuari/welcome).

Per mes info i xuleta pràctica pots consultar: https://cacauet.org/wiki/index.php/Git:_comandes

Per guardar el token i no haver de repetir credencials

$ git config --global credential.helper cache

Crear un nou repositori

Cal distingir clarament entre el repositori local i el repositori remot.

Per crear un repositori local ho farem mitjançant git init , però primer cal crear la carpeta de projecte. Després podrem afegir arxius amb git add i pujar-los a un repositori remot amb git push.

Per crear un repositori remot dependrà del proveïdor que l'hostatgi. Entre d'altres, les opcions que tenim son:

• Github.com
• Gitlab.com
• Un servidor nostre amb accés per SSH

Cada proveïdor té les seves eines, entre elles es pot fer via web. Però sempre ens serà molt útil disposar d'eines CLI (Command Line Interface). Github és la web més popular per hostatjar repositoris gratuïtament i té la eina gh https://cli.github.com/

En Debian/Ubuntu la podem instal·lar amb:

$ sudo apt install gitsome

I després ja ens podem logar. Caldrà que creem un personal access token a la web de Github.com.

$ gh configure

A partir d'aquí podrem crear un repositori remot a Github. Tenim un parell d'opcions:

$ gh repo create <elmeurepo>

Amb això ens crearà un repositori remot, però ens falta lligar el repositori remot amb un de local, i omplir els continguts. Si visiteu la URL del nou repo de Github, allà mateix us apareixerà una «xuleta» de com fer-ho:

https://github.com/elmeuusuari/elmeurepo

En concret, fixeu-vos en la més important:

$ mkdir elmeurepo
$ cd elmeurepo
$ git init
$ git add README.md    # suposant que hem creat un fitxer README.md
$ git commit -m "primer commit"
$ git branch -M main
$ git remote add origin https://github.com/elmeuusuari/elmeurepo
$ git push -u origin main

Fixeu-vos en git remote add origin … que és la que enllaça el repo local i el remot.

Treballar amb branques

Cal tenir en compte i distingir les branques locals i les branques remotes, perquè no son les mateixes.

La comanda bàsica per veure les branques locals és:

$ git branch

Per veure totes les branques, locals i remotes fem:

$ git branch -a

Per crear una nova branca local ho fem amb: (ULL! Això només la crea, però no l'estem utilitzant encara)

$ git branch newbranch

Per canviar-nos a la nova branca:

$ git checkout newbranch

Ara podem pujar la nova branca amb:

$ git push -u origin newbranch

Merge

Una bona referència: documentació Atlassian sobre Git Merge.

$ git log --graph --all --oneline

El merge és una operació que comporta riscos potencialment. El developer que faci un merge es pot trobar amb diversos tipus d'errors:

• Conflicte de versions: significa que a l'hora de barrejar el codi, Git ha detectat que les dues branques o versions tenen línies amb canvis simultanis incompatibles. Qui faci el merge haurà de decidir què fer, si triar una de les versions o fer una barreja de les dues. Caldrà que es revisin el arxius marcat amb conflicte, que ens mostraran les diferències amb algo tipus:

  <<<<<<< HEAD
      Versió que teniem a la branca.
  =======
      Versió que estem fusionant.
  >>>>>>> manolo

• El codi deixa de compilar: potser cada canvi per separat no donava errors i funcionava, i el merge no indica conflicte, però al ajuntar-los el codi deixa de compilar. Caldrà examinar què està passant i posar remei per part dels desenvolupadors responsables.
• L'aplicació aparentment arrenca correctament però una funcionalitat falla: per detectar aquesta situació el més còmode és disposar de tests automatitzats. Si no, és comprensible que després de cada merge caldrà comprovar totes les funcionalitats a mà.

Per procedir a un merge podem seguir les següents passes:

Descarregar els canvis dels altres desenvolupadors (farem git fetch i no git pull per evitar merges automàtics abans de comprovar els canvis):

$ git fetch

Comprovar els canvis mirant l'arbre de versions:

$ git log --graph --all

Anar a la branca destí:

$ git checkout <desti>

Unir la branca <origen> amb la branca <desti>:

$ git merge <origen>

Si surten conflictes, resoldre'ls amb les eines adequades (IDE, compiladors, etc.).

Caldrà fer de nou totes les proves (tests) pertinents (automatitzades o no).

Per finalitzar el merge, fer un commit i un push:

$ git commit -am "merge branca origen"

I pujar els canvis:

$ git push

Git submodules

Sovint necessitem tenir submòduls, és a dir, dependències del projecte principal, per exemple, llibreries, que cal incloure perquè el projecte principal funcioni.

Referències:

• Doc oficial: https://git-scm.com/book/en/v2/Git-Tools-Submodules
• Una referència pràctica: https://voragine.net/scripting/git-submodules

Prenent el cas que tinguem un projecte Desktop i una llibreria Lib, amb els seus repos independents cadascun ja creats, podem incloure Lib dins de Desktop fàcilment.

Entrem a la carpeta de Desktop i fem:

$ git submodule add https://github.com/.../Lib
$ git commit -am "add lib submodule"
$ git push

Ens apareixerà la carpeta Lib amb el contingut del repo ja clonat.

Clonant de nou un repo amb dependències (submodules)

A partir d'ara, quan clonem el projecte principal en una nova ubicació, ens apareixerà la carpeta Lib, però estarà buida. Caldrà que inicialitzem els submòduls des de l'arrel amb:

$ git submodule init

I després podem entrar a cadascuna de les llibreries i descarregar el codi pertinent:

$ cd Lib
$ git submodule update 

Fer que git recordi les credencials

Aquest article explica com evitar que git ens vagi demanant les credencials repetidament quan treballem per línia de comandes.

Resumint, es pot fer així:

git config --global credential.helper store
git config --global credential.helper cache

No és molt recomanable deixar la cache permanentment.

Si volem limitar la cache durant 10 minuts (600 segons) es pot fer amb un timeout:

git config --global credential.helper 'cache --timeout=600'

Com arreglar alguns errors típics de Git

Aquest article ens ensenya alguns trucs imprescindibles de Git:

• Com utilitzar git amend.
• Com afegir un arxiu que he oblidat posar al darrer commit.
• Com esborrar un arxiu que he entrat per error al darrer commit.
• Com arreglar si has fet el commit a la main trunk (branca principal) en lloc d'a la teva branca.
• …i algun més.

Com eliminar dades sensibles emmagatzemades en un repositori. És fàcil que succeeixi: un arxiu .env amb dades de desplegament reals, un arxiu de BD o de test amb contrasenyes reals (encara que estiguin hashejades no convé que algú li pugui fer un atac de diccionari), etc.