5 typů souborů, které je třeba zahrnout do vašeho .gitignore

Kontrola verzí je zásadní nástroj pro sledování změn ve vaší kódové základně, ale ne vždy chcete sledovat každý soubor.

Chcete-li se vyhnout nepořádku a snížit riziko šíření citlivých informací, můžete použít soubor s názvem .gitignore. Tento soubor určuje, které soubory a adresáře by Git neměl indexovat.

Určení, které soubory zahrnout do .gitignore, může být problém, zvláště pokud s vývojem teprve začínáte. Zjistěte, které soubory byste měli přidat do svého .gitignore pro hladší pracovní postup Git.

Vytvoření souboru .gitignore

Aby měl váš soubor .gitignore nějaký účinek, musíte mít v projektu inicializovaný Git.

Git můžete inicializovat spuštěním příkazu níže v terminálu:

git init

Tento příkaz vytvoří nové úložiště Git pro váš projekt ve skrytém podadresáři „.git“, který obsahuje všechny soubory a adresáře, které potřebuje k řízení verzí vašeho projektu.

Chcete-li spustit tento příkaz, musíte mít Git nainstalovaný ve vašem systému.

Dále vytvořte soubor .gitignore spuštěním příkazu níže:

dotek.gitignore

Spuštěním výše uvedeného příkazu se ve vašem aktuálním adresáři vytvoří nový soubor „.gitignore“. Soubor můžete z Gitu vyloučit přidáním názvu souboru nebo cesty k souboru (pokud je soubor v jiném adresáři než .gitignore soubor).

Git nemusí sledovat každý soubor ve vašem projektu a sledování některých souborů může vést k nepředvídatelným problémům. Toto jsou některé ze souborů, které byste měli přidat do svého .gitignore.

1. Konfigurační soubory

Konfigurační soubory ukládají nastavení a další parametry, které vaše aplikace používají k definování a přizpůsobení svého chování. Tyto soubory často ukládají databázové připojovací řetězce, klíče API a další citlivé informace, které byste neměli vystavovat ve svém úložišti Git.

Pokud do svého úložiště zahrnete konfigurační soubory, každý, kdo k němu má přístup, může zobrazit jejich obsah. To může zahrnovat citlivé informace, které mohou vést k narušení bezpečnosti a dalším problémům.

Chcete-li ze svého úložiště Git vyloučit konfigurační soubory, přidejte do něj konkrétní názvy souborů nebo složek .gitignore soubor.

Můžete například přidat řádek níže do svého .gitignore soubor ignorovat a .env soubor.

.env

2. Vytvářejte artefakty

Artefakty sestavení jsou zkompilované nebo vygenerované soubory vytvořené při sestavování projektu. Tyto soubory obvykle žijí v a "cílová" nebo "stavět" adresář.

Artefakty sestavení mohou zahrnovat zkompilované třídy Java, soubory JAR, soubory WAR, binární soubory, distribuční balíčky, sestavy, soubory protokolu a další generované během procesu sestavení.

Obecně je dobrým zvykem vyloučit artefakty sestavení z vašeho úložiště Git, protože mohou být velmi velké. Mohou být také méně přenosné než vaše zdrojové soubory a mohou být relevantní pouze pro konkrétní prostředí. Jejich zahrnutím do vašeho úložiště může zvětšit velikost vašeho úložiště a zpomalit jeho klonování a práci s ním.

Chcete-li vyloučit artefakty sestavení z vašeho úložiště Git, přidejte "cílová/" nebo "stavět/" adresář do vašeho .gitignore soubor.

Například:

# .gitignore
cílová/
stavět/

3. Soubory integrovaného vývojového prostředí

Soubory integrovaného vývojového prostředí (IDE) jsou konfigurační soubory, metadata projektu a další soubory generované vaším IDE při vytváření nebo otevírání projektu. Tyto soubory jsou specifické pro každé IDE. Vaše IDE používá tyto soubory ke konfiguraci nastavení projektu.

Tyto soubory nejsou nutné pro vytváření nebo spouštění vaší aplikace a často mohou způsobit problémy, pokud jsou uloženy do sdíleného úložiště Git. Různí lidé ve vašem týmu mohou například používat různá IDE nebo verze a odevzdání souborů specifických pro IDE by mohlo způsobit konflikty při sloučení a ztížit spolupráci na projektu.

Protože tyto soubory jsou specifické pro IDE, soubory, které chcete zahrnout do vašeho .gitignore soubor bude záviset na vašem IDE. Tady jsou Doporučení GitHubu .gitignore pro některá populární IDE. Můžete vyhledat své IDE a přidat do něj nastíněné soubory .gitignore soubor.

4. Závislosti a soubory balíčků

Soubory závislostí a balíčků jsou soubory, které obsahují informace o závislostech a balíčcích používaných vaší aplikací. Různé stavební nástroje, jako např správce balíčků uzlů (npm), vygenerujte tyto soubory.

Pokud například používáte npm ke správě závislostí pro projekt JavaScript, vytvoří se "node_modules“ v kořenovém adresáři vašeho projektu. Adresář obsahuje všechny nainstalované závislosti pro váš projekt.

Tento adresář může být velmi velký, zejména pokud má váš projekt mnoho závislostí nebo některé závislosti mají velké soubory. Vyloučením "node_modules" z vašeho úložiště Git, můžete ji udržovat čistou a zmenšit její velikost.

Abyste se vyhnuli přidání "node_modules" do svého úložiště Git, přidejte jeho název do souboru .gitignore:

#.gitignore
node_modules/

5. Soubory operačního systému

Váš operační systém a další systémové nástroje mohou generovat soubory běžným používáním. Mohou zahrnovat soubory protokolu, dočasné soubory a soubory konfigurace systému. Příkladem je Thumbs.db soubor v systému Windows a jeho ekvivalentu pro macOS, .DS_Store soubor.

Obecně je dobrým zvykem vyloučit soubory operačního systému z vašeho úložiště Git tak, jak jsou jsou specifické pro vaše místní prostředí a mohou se lišit mezi různými počítači a operačními systémy systémy.

GitHub doporučil pokyny pro .gitignore Okna, Operační Systém Mac, a Linux.

Význam správy verzí

Používání správy verzí může výrazně zlepšit váš pracovní postup a omezit chyby a konflikty, které mohou nastat při práci na kódové základně. Pomocí správy verzí můžete snadno sledovat změny kódu, kontrolovat je a bezproblémově spolupracovat se členy týmu.

Vždy byste však měli vyloučit určité soubory, jako jsou konfigurační soubory, soubory IDE a soubory OS. Tím se sníží velikost vašeho úložiště a zajistí se, že neuniknou citlivé informace.