Skapa .gitignore

Välj alla tekniker som används i det här kodförrådet.

Regler för operativsystem och editorer hör oftast hemma i din globala fil för Git-undantag.

Nästa: granska reglerna

Välj teknikerna i kodförrådet för att skapa en .gitignore för genererade filer, installerade beroenden och lokala miljöfiler. Du kan välja flera tekniker. Valfria regler för operativsystem och editorer visas separat, så att personliga inställningar kan läggas i din globala fil för Git-undantag.

Skapa och använd undantagsreglerna

  1. 1

    Välj projektets tekniker

    Välj allt som används i kodförrådet, till exempel Laravel och Node.js för en PHP-app med ett frontendbygge.

  2. 2

    Lägg till personliga regler vid behov

    Välj operativsystem eller editor för att se separata globala undantag. Lämna fälten tomma om din befintliga globala fil redan täcker dem.

  3. 3

    Granska och kopiera eller ladda ned

    Kontrollera projektreglerna. Kopiera dem till en `.gitignore` i kodförrådets rotkatalog eller ladda ned ZIP-filen och packa upp dess `.gitignore` där. Lägg eventuella personliga regler i din globala fil för Git-undantag.

  4. 4

    Kontrollera före incheckning

    Checka in projektets `.gitignore` så att kollegorna får den. Se till att filer som ska vara med, särskilt exempelfiler och låsfiler för beroenden, fortfarande syns i Git.

Vilka regler hör hemma var?

Regeltyp Placering Exempel
Byggresultat och installerade beroenden En incheckad .gitignore i kodförrådet node_modules/, vendor/, __pycache__/
Lokala miljövärden Projektets .gitignore .env och lokala varianter av .env.*
Egna filer från operativsystem och editor En global fil för Git-undantag, eller .git/info/exclude för ett enda kodförråd Finder-metadata eller säkerhetskopior från editorn
Filer som kollegor behöver Behåll dem spårade när det är lämpligt .env.example, package-lock.json, composer.lock, Gemfile.lock

Git läser projektets .gitignore, kodförrådets lokala .git/info/exclude och din personliga core.excludesFile. En projektregel följer med kodförrådet när du checkar in .gitignore. En personlig regel gäller normalt bara på din dator. Läs Git-manualen för ignore-regler och GitHubs guide till att ignorera filer.

Exempel: en Node.js-tjänst med Python-skript

Välj Node.js och Python. Projektfilen kombinerar regler för installerade paket som node_modules/, byggresultat från Node som dist/ och filer som Python skapar, till exempel __pycache__/ och .venv/. Lokala .env-värden undantas samtidigt som en spårad .env.example kan behållas. Om du använder Mac och Visual Studio Code kan du välja de personliga alternativen och granska deras regler separat. Kontrollera båda resultaten mot ditt kodförråd innan du sparar dem.

Generatorn utgår från valda mallar. Den kan inte läsa dina filer eller avgöra om dist/ innehåller byggresultat eller källkod som ska checkas in. Begränsa eller ta bort en regel som krockar med projektet. Kör git check-ignore -v path/to/file för att se vilken regel som träffar en ospårad fil. GitHubs mallsamling visar vanliga mönster, men ersätter inte en granskning av ditt kodförråd.

Miljöfiler och låsfiler

Att ignorera .env hjälper till att hålla lokala inloggningsuppgifter borta från nya incheckningar, men tar inte bort en hemlighet som redan har checkats in. Om den finns i Git-historiken behöver du sluta spåra filen, bedöma var uppgiften har kopierats och byta ut den. Behåll bara en rensad .env.example med platshållare, utan riktiga hemligheter. Den skapade .gitignore innehåller redan undantaget !.env.example så att det bredare mönstret .env.* inte döljer exempelfilen; behåll undantaget om du redigerar reglerna.

För applikationer bör låsfiler checkas in, så att valda beroendeversioner kan installeras igen. npm rekommenderar att package-lock.json checkas in och Composer rekommenderar detsamma för composer.lock. Bibliotek kan ha andra rutiner; följ projektets bygg- och publiceringspolicy.

Vanliga frågor

Undantagsregler gäller filer som Git ännu inte spårar. Kör git rm --cached path/to/file för att sluta spåra en fil men behålla din lokala kopia och checka sedan in borttagningen. Om filen innehöll en hemlighet ska du byta ut den och granska Git-historiken och eventuella kopior.

Behåll normalt en rensad .env.example och applikationens låsfiler i Git. Exempelfilen visar vilka miljönycklar som behövs och låsfilen låser beroendeversioner för kollegor och driftsättning. Kontrollera att exempelfilen inte innehåller riktiga hemligheter.

Ja. Välj alla tekniker som används i samma kodförråd. Generatorn sammanför projektreglerna i en enda .gitignore. Granska resultatet om ditt projekt använder vissa sökvägar på ett annat sätt.

Använd en global fil för Git-undantag om personliga regler ska gälla flera kodförråd. När XDG_CONFIG_HOME inte är satt använder Git normalt ~/.config/git/ignore; en annan sökväg kan anges med core.excludesFile. Använd .git/info/exclude för en privat regel i bara detta kodförråd. Lägg inte de separata personliga reglerna i den delade projektfilen om inte teamet vill ha dem där.

Valda tekniker och eventuella val av operativsystem eller editor skickas till servern för att bygga reglerna. I flödet med flera steg syns valen också i sidans webbadress. Lägg inga hemligheter där. Verktyget skapar regler utifrån valen; det läser inte ditt kodförråd och laddar inte upp dess filer.

Relaterade verktyg

Verktyget finns på andra språk