Hva er en .gitignore-fil?

En .gitignore-fil forteller Git hvilke filer som skal utelates fra versjonskontrollen: avhengigheter du kan installere på nytt (som node_modules), byggutdata, logger, cache, innstillinger for redigeringsprogrammer og filer operativsystemet legger igjen, som .DS_Store på macOS eller Thumbs.db på Windows. Plasser den i rotmappen til repositoriet. Mønstrene gjelder for den mappen og alle undermapper.

Hvor kommer malene fra?

Malene er fra GitHubs offisielle samling, github/gitignore-repositoriet, de samme som GitHub tilbyr når du oppretter et repository. Verktøyet laster inn en kopi som oppdateres hver dag. De er delt inn i tre grupper:

  • Hovedmaler for språk, rammeverk og verktøy, som Node, Python, Java, Go, Rust, Unity og WordPress.
  • Globale maler for redigeringsprogrammer, operativsystemer og andre verktøy, som macOS, Windows, Linux, VisualStudioCode, JetBrains og Vim. De passer både i prosjektets .gitignore og i den globale filen som Git kan bruke på alle repositoryene dine.
  • Fellesskapsmaler for mer spesialiserte rammeverk og verktøy, vedlikeholdt av fellesskapet, som JavaScript/Vue eller Python/JupyterNotebooks.

Slik bruker du den

  1. Start med et raskt valg for en populær prosjekttype. Det velger malene for teknologistakken, samt macOS, Windows og redigeringsprogrammet som vanligvis brukes med den.
  2. Du kan også søke i feltet Maler og velge alle språkene, rammeverkene, redigeringsprogrammene og operativsystemene prosjektet ditt bruker. Fjern avmerkingen for en mal, eller trykk på Backspace i feltet, for å fjerne den.
  3. .gitignore-filen bygges etter hvert som du velger, med hver mal under sin egen overskriftskommentar, i den rekkefølgen du valgte dem.
  4. Kopier filen, eller last den ned og lagre den i rotmappen til repositoriet som .gitignore. Nettlesere lagrer ikke filer med navn som begynner med et punktum, så den nedlastede filen får navnet gitignore.txt eller gitignore: gi den nytt navn til .gitignore.

Tips

  • To maler kan inneholde det samme mønsteret, for eksempel node_modules/ i Node og Nextjs. Det gjør ingen skade om et mønster gjentas.
  • Et mønster slutter ikke å spore en fil som Git allerede sporer. Hvis du vil slutte å spore den, men beholde den på disken, kjører du git rm --cached etterfulgt av filens bane, og oppretter deretter en commit.
  • En linje som begynner med !, tar tilbake filer som et tidligere mønster ignorerte. VisualStudioCode-malen bruker dette til å beholde delte innstillinger, som .vscode/settings.json, i repositoriet.

Funksjoner

  • GitHubs offisielle .gitignore-maler, oppdatert hver dag
  • Språk, rammeverk, redigeringsprogrammer og operativsystemer i én søkbar liste
  • Raske valg for populære prosjekttyper
  • Hver mal under sin egen overskrift
  • Kopier eller last ned filen