Generátor souboru .gitignore
Zaškrtněte, co v projektu používáte, a nástroj složí .gitignore. Vlastní pravidla přidáte do pole vlevo.
Vlastní pravidla (jedno na řádek)
Obsah .gitignore
Co do .gitignore patří a co ne
Do repozitáře nepatří nic, co vznikne sestavením projektu nebo instalací závislostí — node_modules, vendor, target, přeložené soubory. Tyhle adresáře jsou velké, mění se s každým buildem a kdokoli si je umí vygenerovat z package.json nebo composer.json.
Druhá skupina jsou soubory s konfigurací konkrétního počítače nebo s tajemstvími: .env, privátní klíče, lokální databáze. Ty se do gitu nesmí dostat vůbec, protože jednou zapsaný obsah zůstane v historii i po smazání.
- Ignorujte adresáře se závislostmi a výstupy buildu.
- Ignorujte
.env, ale verzujte.env.examplese seznamem proměnných. - Systémové soubory jako
.DS_Storeignorujte raději i globálně přescore.excludesfile.
Proč .gitignore nefunguje na už sledované soubory
Pravidlo v .gitignore platí jen pro soubory, které git zatím nesleduje. Pokud jste .env jednou commitli, přidání pravidla nic neudělá — je potřeba soubor odebrat z indexu příkazem git rm --cached .env a změnu commitnout.
Vykřičník na začátku řádku znamená výjimku z předchozího pravidla. Proto v generovaném souboru najdete dvojici .env.* a !.env.example — ignoruje se vše kromě vzorového souboru.
Časté dotazy
Kam soubor .gitignore uložit?
Do kořene repozitáře. Pravidla pak platí i pro podadresáře. Ve větších projektech můžete mít vlastní .gitignore i v podadresáři, kde platí navíc k tomu kořenovému.
Odstraní .gitignore soubor, který už je v historii?
Ne. Ignorování se týká jen budoucích commitů. Odstranění z historie vyžaduje přepis historie, například nástrojem git filter-repo, a domluvu se všemi, kdo repozitář klonovali.
Můžu ignorovat celý adresář kromě jednoho souboru?
Ano, ale musíte nejdřív povolit průchod adresářem. Kombinujte pravidla ve tvaru adresar/* a !adresar/soubor.txt, jinak git do ignorovaného adresáře vůbec nenahlédne.