Pokud ve svém projektu používáte Yarn, pravděpodobně znáte soubor yarn.lock. Tento soubor obsahuje informace o verzích balíčků nainstalovaných ve vašem projektu. Při práci s Git však není vždy nutné tento soubor komunikovat. Změny v yarnu.lock může být způsoben například pouze aktualizací jednoho balíčku, zatímco zbytek kódu zůstává stejný. Časté návštěvy v yarnu.lock může vést k mnoha zbytečným změnám v historii Git.
Abyste se tomuto problému vyhnuli, můžete přidat yarn.lock do souboru .gitignore. V tomto článku se podíváme na to, jak snadné je přidat yarn.lock v .gitignore a vyhnout se zbytečným komunikacím.
Chcete-li začít, otevřete soubor .gitignore je kořenem vašeho projektu. Pokud jste jej ještě nevytvořili, jednoduše vytvořte nový soubor a pojmenujte jej .gitignore. V tomto souboru můžete pomocí šablon ignorovat konkrétní soubory a složky. Přidejte do souboru další řádek .gitignore:
yarn.lock
Poté Soubor uložte a zavřete. Nyní bude git ignorovat soubor yarn.jeho změny se ale nechystají. Všimněte si však, že pokud jste již měli komity souboru yarn.lock, přidání do .gitignore jej z historie Git neodstraní. Při dalších komunikacích bude jednoduše ignorován.
Co je yarn lock a proč jej přidávat do gitignore?
Přidání souboru yarn.lock v .gitignore je dobrá praxe, protože by neměla být zahrnuta do úložiště Git. Důvodem je yarn.lock je soubor, který se automaticky generuje a mění pokaždé, když nainstalujete nebo aktualizujete balíčky. To znamená, že jeho obsah může být nestabilní a může se měnit pro různá vývojová prostředí a pracovní stroje.
Ignorování yarn.lock při práci s Git zabraňuje problémům souvisejícím s rozdíly v závislostech při spolupráci na projektu a také pomáhá zjednodušit proces nasazení, protože umožňuje instalaci balíčků podle klíče verze v souboru package.json.
Tedy přidání yarnu.lock v .gitignore je doporučená praxe, která podporuje jednodušší a spolehlivější správu závislostí projektu.
Krok 1. Vytvoření nebo otevření .gitignore souboru
Před přidáním yarn lock do .gitignore, je třeba se ujistit, že soubor již existuje. Pokud soubor .gitignore je již přítomen v kořenovém adresáři vašeho projektu, přejděte k dalšímu kroku.
Pokud ano .gitignore ne, vytvořte jej následovně:
- Otevřete kořenový adresář svého projektu v editoru kódu, který vám vyhovuje;
- Vytvořte nový soubor a pojmenujte jej .gitignore, všimněte si tečky na začátku názvu souboru;
- Otevřete soubor, který jste právě vytvořili .gitignore pro zahájení jeho úprav.
Pokud soubor .gitignore byl nalezen nebo úspěšně vytvořen, přejděte k druhému kroku.
Krok 2. Přidání yarn.lock v .gitignore
Po vytvoření souboru .gitignore dalším krokem je přidat do něj řádek zodpovědný za ignorování souboru yarn.lock.
Otevřete soubor .gitignore v jakémkoli textovém editoru nebo IDE.
Přidejte do souboru následující řádek .gitignore:
Tento řádek říká systému správy verzí, aby ignoroval soubor yarn.lock při provádění operací git.
Po přidání řádku uložte soubor .gitignore.
Nyní bude git ignorovat soubor yarn.lock při provádění příkazů git add a git commit.
Krok 3. Kontrola změn a commit v Git
Před přidáním změn do .gitignore soubor a provést commit, je třeba zajistit, aby všechny změny jsou správné a nezpůsobí problémy při práci s projektem.
1. Zkontrolujte změny v .soubor gitignore je správný a obsahuje potřebné soubory a adresáře.
2. Ujistěte se, že všechny změny v projektu jsou správné a nezpůsobují chyby při kompilaci nebo provádění kódu.
3. Spusťte testy, abyste se ujistili, že jsou úspěšné a nezpůsobují chyby.
4. Ujistěte se, že neexistují žádné náhodně přidané soubory, které by neměly být součástí úložiště.
Po ověření je nutné provést příkaz pro přidání změn a provedení obchodu:
- git add .gitignore
- git commit-m "přidání .gitignore souboru"
První tým přidává .gitignore soubor v seznamu změn, které budou zahrnuty v commit. Druhý tým provede commit s uvedenou zprávou. Můžete nahradit zprávu vhodnější popisující odvedenou práci.
Po úspěšném provedení příkazů budou změny uloženy v úložišti Git a .gitignore soubor bude při práci s Git ignorován.