Android/Control de versions VCS amb Android Studio/VCS local

Introducció

Android Studio utilitza una VCS local (Local History) per fer un seguiment constant de tots els canvis que anem realitzant al codi del nostre projecte. A diferència d'un VCS remot en el que es mostren les diferències entre diferents commits, la local history manté automàticament versions per a tots els esdeveniments significatius que es fan localment. Això permet obtenir un timeline dels canvis en l'estructura del projecte i del codi font, amb la possibilitat de restaurar el nostre projecte a qualsevol punt si és necessari.

Visualització de la Local History

Local History d'un directori

Local History d'un fitxer

Per visualitzar la Local History cal fer el següent:

Seleccionem el fitxer/s o directori/s que vulguem conèixer el seu historial de modificacions de l'arbre de directoris de l'Android Studio.
Al menú d'opcions de la part superior de l'editor de l'Android Studio, seleccionem VCS | Local History | Show History.

La Local History conté un llistat de versions i mostra les diferències entre elles. Quan es visualitza la Local History d'un directori, les versions només mostren els noms dels fitxers que han canviat al directori. En canvi, les versions de les modificacions d'un fitxer específic, mostren els canvis que s'han produït en el contingut d'aquell fitxer.

Si es vol restaurar una versió específica de la Local History cal realitzar els passos següents:

Obrir la finestra Show History.
Seleccionar la versió de la llista i clicar sobre la icona de la barra d'eines.

Aquesta acció generarà una nova versió a la Local History.

Visualització d'elements del codi font

Local History d'una Class

En el cas de que no es vulgui veure la Local History de tot el fitxer, sinó solament una part específica del codi com: classes, mètodes, funcions o qualsevol fragment del codi seleccionat. Podem fer-ho de la següent manera:

Visualitzar l'historial d'una classe

Cliquem amb el botó dret del ratolí al nom de la classe a l'editor.
En la barra que apareix seleccionem les opcions Local History | Show History for Class.

Visualitzar l'historial d'un mètode d'una classe

Cliquem amb el botó dret del ratolí al nom del mètode de la classe a l'editor.
En la barra que apareix seleccionem les opcions Local History | Show History for Method.

Visualitzar l'historial d'un fragment del codi

Cliquem amb el botó dret del ratolí al text seleccionat a l'editor.
En la barra que apareix seleccionem les opcions Local History | Show History for Selection.

Afegint Labels a la Local History

En visualitzar 'Local History podem observar que tenim diferents versions de modificacions que no són fàcils de navegar o identificar. Algunes d'aquestes versions, vénen marcades per defecte amb una etiqueta que descriu un "event" predefinit tals com: commits,patchs, etc. També és possible crear les nostres pròpies etiquetes per tal d'identificar la versió actual i descriure-la segons ens sembli. Per fer-ho, realitzem els passos següents:

Al menú d'opcions de l'editor, seleccionem les opcions VCS | Local History | Put Label.
N'apareixerà la nova finestra Put Label' en el que escriurem el nom de l'etiqueta i premerem Accept per crear l'etiqueta definitivament.

Compartir Local History

La local history està pensada per a ús personal i per tant, no és possible l'accés compartit. Tot i així, hi ha la possibilitat d'exportar en un fitxer .patch els canvis relatius a una versió específica que pot ser compartit amb altres usuaris. Per generar el fitxer .patch, realitzem els següents passos:

Seleccionem la versió pertinent de la Local History i cliquem amb el botó dret del ratolí sobre aquesta versió.
En la nova finestra d'opcions que ens apareix, seleccionem l'opció Create Patch.

Període de guardat de la Local History

Per defecte, la nostra Local History està configurada perquè guardi les versions produïdes durant els últims 5 dies de treball (és a dir, dies en què l'arxiu s'ha modificat). Per tal de canviar aquest període de retenció, podem modificar la configuració per tal d'ampliar-lo o reduir-lo segons ens convingui. Per fer-ho, realitzarem els passos següents:

Al menú d'opcions de l'editor, seleccionem les opcions Help | Find Action o (Ctrl+Shift+A).
En la nova finestra, cerquem i obrim l'editor Registry.
Modifiquem el valor del paràmetre localHistory.daysToKeep.
Cliquem en el botó Close i reiniciem l'Android Studio per tal d'aplicar els canvis.

En el cas que es vulgui deshabilitar la Local History completament, s'ha d'especificar com a paràmetre del període de retenció el valor 0.

Ubicació dels fitxers de la Local History

La Local History es guarda com a fitxers binaris dins de la carpeta LocalHistory del directori d'instal·lació de l'Android Studio.

Windows - %HOMEPATH%\.AndroidStudio<versió>;;\system
macOS - ~/Library/Caches/AndroidStudio<versió>;;
Linux - ~/.AndroidStudio<versió>;;/system

Referències

IntelliJ Guia d'usuari