0 bodů

Git · 35 min

.gitignore a dobrý postup práce

Jak souborem .gitignore říct Gitu, co nesledovat, jak přestat sledovat omylem přidaný soubor, jak odložit rozdělanou práci přes git stash a jaké návyky dělají z Gitu pomocníka.

Lidsky řečeno

Když stěhuješ byt, nebalíš všechno. Odpadky, krabice od pizzy a věci, které se dají koupit znovu, necháš být. Do repozitáře taky nepatří všechno: dočasné soubory, logy, stažené knihovny nebo hesla. Soubor .gitignore je seznam „tohle nestěhuj“. A git stash je krabice, do které na chvíli schováš rozdělanou práci, když musíš rychle řešit něco jiného.

Obtížnost: 2 z 5. Stačí umět git add, git commit a git status.

Co do repozitáře nepatří

  • Hesla, tokeny a klíče (.env, config.local.php, id_ed25519). Z historie se dostávají velmi těžko.
  • Vygenerované soubory, které vzniknou ze zdrojáků: složka build/, dist/, zkompilované *.o, *.class, __pycache__/.
  • Stažené závislosti: node_modules/, venv/, vendor/. Dají se kdykoli stáhnout znovu podle package.json nebo requirements.txt.
  • Logy a dočasné soubory: *.log, *.tmp, *.swp.
  • Soubory systému a editoru: .DS_Store (macOS), Thumbs.db (Windows), .idea/, .vscode/ (podle domluvy týmu).

Soubor .gitignore

.gitignore je obyčejný textový soubor v kořeni repozitáře. Každý řádek je jedno pravidlo. Soubor samotný se commituje, aby pravidla platila pro všechny.

text
# komentář
*.log            # všechny soubory končící .log, v jakékoli složce
node_modules/    # lomítko na konci = jen složka (a všechno v ní)
/config.local    # lomítko na začátku = jen v kořeni repozitáře
build/
docs/*.pdf       # pdf přímo ve složce docs
**/tmp           # složka tmp kdekoli v hloubce
!dulezite.log    # vykřičník = výjimka, tenhle soubor neignoruj

Komentář musí být na samostatném řádku, za pravidlem by se bral jako jeho součást (v ukázce jsou vedle pravidel jen pro vysvětlení). Pozdější pravidlo přebíjí dřívější, proto výjimky s ! piš až pod obecné pravidlo. Ignorované soubory git status vůbec neukazuje. Uvidíš je přes git status --ignored a příkaz git check-ignore -v soubor ti řekne, které pravidlo ze kterého řádku soubor ignoruje.

Úkol v terminálu

Založ .gitignore

V projektu se objevil log debug.log a složka node_modules se staženými knihovnami. Nic z toho nechceš v repozitáři. Vytvoř .gitignore, který ignoruje všechny soubory končící .log a složku node_modules, a commitni ho. Na konci musí git status hlásit čistou pracovní složku.

Načítám terminál…

Úkol v terminálu

Přestaň sledovat soubor s heslem

Soubor .env s heslem k databázi se omylem dostal do commitu. Zařiď, aby ho Git přestal sledovat (na disku musí zůstat, aplikace ho potřebuje), přidej ho do .gitignore a vše commitni.

Načítám terminál…

Úkol v terminálu

Ignoruj logy, ale jeden ne

.gitignore ignoruje všechny *.log. Soubor dulezite.log je ale vzorový log, který do repozitáře patří. Uprav .gitignore tak, aby chyby.log zůstal ignorovaný a dulezite.log ne, a dulezite.log přidej do indexu. Nepoužívej git add -f.

Načítám terminál…

git stash: odlož rozdělanou práci

Pracuješ na nové funkci a přijde urgentní oprava. Rozdělanou práci nechceš commitovat (není hotová) ani zahodit. git stash ji odloží stranou a pracovní složku vrátí na poslední commit.

bash
git stash                     # odlož změny sledovaných souborů
git stash -u                  # i nesledované soubory
git stash push -m "menu"      # s popisem
git stash list                # seznam odložených (stash@{0} je nejnovější)
git stash pop                 # vrať poslední odložené a smaž ho ze seznamu
git stash apply               # vrať, ale nech v seznamu
git stash drop                # zahoď poslední odložené
Úkol v terminálu

Odlož práci a oprav urgentní chybu

Máš rozdělanou úpravu index.html (nový slogan), která ještě není hotová. Šéf volá, že na kontaktní stránce je špatný telefon. Odlož rozdělanou práci, přepiš kontakt.html na <p>Telefon: 777 123 456</p>, commitni opravu se zprávou Opraven telefon a potom si rozdělanou práci vrať. Rozdělaný slogan nesmí skončit v commitu.

Načítám terminál…

  1. Malé commity, jedna věc v každém. Snáz se popisují, kontrolují i vracejí.
  2. Před commitem se podívej, co ukládáš: git status a git diff --staged. Zabrání to commitu s heslem nebo ladicím výpisem.
  3. Každá funkce ve vlastní větvi (git switch -c oprava-menu). main drž vždy funkční.
  4. Začni git pull, skonči git push. Synchronizuj se často.
  5. Piš srozumitelné zprávy. Co se změnilo, případně proč. Ne oprava2.
  6. Nepřepisuj sdílenou historii. Na odeslané commity jen revert, žádné reset a --force.
  7. .gitignore založ hned na začátku, ještě před prvním git add ..
Pod kapotou · Konvence zpráv a hooky

V mnoha projektech se používá formát Conventional Commits: typ(oblast): popis, například fix(menu): zavírání na mobilu nebo feat: export do PDF. Nástroje z něj umí generovat seznam změn a čísla verzí. Kontrolu před commitem automatizují hooky: skripty v .git/hooks (například pre-commit), které Git spustí v určitém okamžiku a které můžou commit zastavit, třeba když v kódu najdou heslo nebo když neprojdou testy. Hooky se do repozitáře nekopírují, týmy je proto sdílejí přes nástroje jako pre-commit nebo husky. Pro velké binární soubory (videa, modely) existuje rozšíření Git LFS.

Procvič si to

Kvíz

Do .gitignore jsi přidal .env, ale git status pořád ukazuje změny v .env. Proč?

Kvíz

Co znamená řádek build/ v .gitignore?

Kvíz

Co udělá git stash pop?

Roztřiď

Patří do repozitáře?

Rozhodni, co do repozitáře webové aplikace patří.

Kartičky

Opakování: .gitignore a stash