.gitignore : i file ignored in Git

Abbiamo visto in precedenza che Git considera i file presenti nella working copy distinguendoli in tracked (file che sono stati committati nel repository o inclusi nella staging area) e untracked (l’opposto del precedente).

A questi due gruppi possiamo aggiungerne un terzo, i file ignored, ossia i file per i quali Git è stato espressamente istruito di escluderli dal controllo di versione.

I file ignored sono tipicamente artefatti di build o altri file generati che possono essere ricreati a partire dai sorgenti del repository, oppure file che contengono contenuti che non devono essere inclusi nei commit per altri motivi (per esempio password, chiavi di autenticazione o altri secret).

Per indicare quali file ignorare viene utilizzato il file speciale .gitignore, solitamente presente nella directory iniziale del progetto. È comunque possibile salvare un file .gitignore in ogni sottodirectory, che integra o sostituisce le regole del file “genitore” in quella directory e nelle sue “figlie”.

Non esiste un comando specifico di Git, quindi sarà necessario modificare il contenuto di tale file con un editor di testo. Ovviamente, è opportuno aggiungere e committare il file .gitignore nel repository, in modo che ne sia parte integrante.

Il contenuto esatto del file .gitignore dipende dalla natura del progetto. Esistono raccolte di template  con file specifici in base al linguaggio di programmazione e al framework utilizzato. Per esempio, un template per un progetto in linguaggio PHP con framework Laravel è:

/vendor/
node_modules/
npm-debug.log
yarn-error.log

# Laravel 4 specific
bootstrap/compiled.php
app/storage/

# Laravel 5 & Lumen specific
public/storage
public/hot

# Laravel 5 & Lumen specific with changed public path
public_html/storage
public_html/hot

storage/*.key
.env
Homestead.yaml
Homestead.json
/.vagrant
.phpunit.result.cache

Le righe che iniziano con # sono commenti.
Per quanto riguarda le altre, su ciascuna riga è indicato un pattern da ignorare (o il percorso esatto di un file).

In base al pattern indicato, verranno ignorati specifici file nella directory, ad esempio:

• /logs - ignora il file o directory logs nella directory corrente (quindi /logs ma non /example/logs
• logs - ignora i file e le directory con nome logs nella directory corrente e nelle sottodirectory (quindi /logs, /example/logs, /debug/logs/debug.log, ma non /build/log/today
• logs/ - ignora solo le directory con nome logs (quindi la directory /build/logs e tutti i file contenuti ma non il file debug/logs)

È anche possibile indicare quali file non ignorare se un altro pattern dovesse indicare il contrario tramite un !. Ad esempio

# ignora tutti i file con estensione .log
*.log
# NON ignorare i "debug.log"
!debug.log

È buona pratica creare un file .gitignore globale che vale per tutti i repository Git presenti sulla propria macchina. In tale file possono essere indicati i pattern che vanno ignorati in ogni progetto, per esempio i file creati dal proprio sistema operativo (come .DS_Store and thumbs.db) o le directory create dal proprio IDE/Editor.

touch ~/.gitignore
git config --global core.excludesFile ~/.gitignore

Con questi comandi creiamo un file .gitignore nella propria directory home e istruiamo Git a usarlo come file di ignore globale.

È possibile aggiungere ai file ignorati un file che è stato in passato aggiunto al repository, tramite i seguenti comandi:

$ echo debug.log >> .gitignore
$ git rm --cached debug.log
rm 'debug.log'
$ git commit -m "rimosso debug.log dal repository"

Attenzione però: in tutti i commit precedenti il file resterà ovviamente disponibile (Git conserva la history).