Dotaz: Git describe v PHP

[Josef Kufner]

Dobré ráno,

pro deploy aplikace v PHP používám Git, takže document root je současně i repositářem. Aplikace je to veliká a její nasazování nemám zcela pod kontrolou, takže je dobré na webu vidět někde v patičce označení instalované verze.

V současné době mám připravený script, který na repositář pustí "git describe" (plus pár dalších věcí) a výstup uloží do ini souboru, ze kterého si to aplikace pomocí parse_ini_file() načte a zobrazí.

Aplikace si ten script spouští sama, když zjistí, že ini soubor je starší než .git/HEAD a to kam tenhle odkazuje. Uživatel (správce) nemusí řešit vůbec nic.

Potíž je v tom, že ne vždy je na serveru dostupný Git nebo není možné spouštět externí programy. Hooky nepřipadají v úvahu, protože se musí nastavit ručně a o to se nikdo nechce starat. Cílem je nulová administrace a spolehlivá funkčnost bez externích nástrojů.

Takže jako nejlepší řešení se mi jeví implementace tohoto v PHP:

git describe --tag --match='v[0-9]*'
git log -n 1 --pretty='%ai'

Nevíte o nějaké knihovně v čistém PHP, která by tohle uměla? Co jsem tak našel, ten log by nebyl problém, ale co describe?

---

---

Odpovědi

[Josef Kufner]

No, vypadá to, že asi nejlepší je Glip. Vytáhnout log jde s ním lehce, ale neumí to ani vypsat seznam existujících tagů, natož z toho spočítat, který je nejblíž

[Josef Kufner]

Takže jsem si s tím trošku pohrál a (zjednodušená) implementace git describe je na světě ... přesněji na GitHubu.

[pavlix]

Potíž je v tom, že ne vždy je na serveru dostupný Git nebo není možné spouštět externí programy.

V takovém případě se dělá git deployment velmi špatně... ale existuje na to lék... dělat deployment lokálně, pustit skripty a odeslat pomocí rsyncu.

Mimochodem, pokud to jenom trochu lze, vždy se vyhýbám hostování aplikací v omezeném prostředí. Zpravidla věci tohoto typu (git, spouštění příkazů) uvádím jako součást systémových požadavků, a pokud tomu zákazníkův dodavatel služeb nerozumí, velmi rychle mu mezi svými obchodními partnery najdu nového.

Ještě jednu velmi dobrou radu ti můžu dát (klidně mě kontaktuj s dotazy)... nikdy si nenech diktovat technické prostředky, pokud si za práci v omezeném prostředí nenaúčtuješ samostatnou položku.

Pokud kývneš zákazníkům či jejich dalším dodavatelům na každou blbost, zvyknou si na to a budou se k tobě podle toho chovat. A to zdaleka neplatí jen pro komerční spolupráci.

[Josef Kufner]

Právě pokud se dělá deploy rsyncem nebo třeba pomocí sshfs, tak tenhle problém nastává. Hooky nastaveny nejsou, protože se na ně zapomělo, a při další příležitosti nějaký kód spustit už Git k dispozici není.

S těmi požadavky máš pravdu, ale já jsem v situaci, kdy zákazníka ještě nemám a proto chci, aby můj produkt měl co nejméně závislostí a zvýšila se tak šance, že ho získám (resp. že jich získám více). A zrovna omezení spouštění externích nástrojů i potřeba vidět číslo verze jsou celkem časté, proto to řeším. Dalším důvodem je to, že tím produktem je framework, takže deploy může probíhat všelijak.

[pavlix]

Zkusme někdy zajít na pivo/kafe/whatever... pohybuju se různě po republice, takže by neměl být problém to někdy zvládnout. Už jsem viděl pár neúspěšných projektů a na některých jsem se i podílel. Vytvářet produkt bez zákazníka není úplně easy, můžu tě na pár věcí upozornit.

Rozumím, takže to vidím úplně jednoduše. Píšeš, že se používá git a rsync nebo SSH/SFTP. V takovém případě je potřeba na vzdálenou stranu protlačit třeba ten hotový inifile, nebo klidně jen kus zdrojáku, kde je do proměnné uložen výstup git describe...

Pokud se za všech okolností používá alespoň lokálně git, nevidím smysl v hledání jiného řešení. No a pokud se git používá i na vzdáleném stroji, tak není problém tam nastavit hooky, třeba spuštěním skriptu po SSH pomocí informace o větvích z lokálního .git/config.

[Josef Kufner]

Zatím to je jen hotová bakalářka a rozdělaná diplomka. Používám to, když vyrábím nějaký web (na zakázku). Časem to vypustím do světa a možná se tu o tom objeví i článek, ale v tuhle chvíli si ještě nejsem moc jistý, co jsem to vlastně vyrobil a jak se to používá.

Pointa mého snažení s Gitem v PHP je, aby nebylo třeba udělat vůbec nic navíc, jen checkout (clone) do document root. Nahrát hotový INI file je celkem triviální, potíž je, že není kde a kdy ho vyrobit.

Spuštění skriptu, který by nastavil hooky je sice celkem hezké, ale závisí to na uživateli (adminovi/programátorovi), takže se na to nelze spolehnout (prakticky ověřeno).

Dalším háčkem je, že používám submoduly pro pluginy, takže by to znamenalo hlídat hooky pro každý plugin. Tohle je okamžik, kdy to přestává být praktické.

[pavlix]

Pointa mého snažení s Gitem v PHP je, aby nebylo třeba udělat vůbec nic navíc, jen checkout (clone) do document root. Nahrát hotový INI file je celkem triviální, potíž je, že není kde a kdy ho vyrobit.

To mi přijde takové... neužitečné. Git clone k tomuhle není určený, navíc funguje víceméně jen při shellovském přístupu. Hooky se nekopírují (z pochopitelných důvodů). Na to je daleko vhodnější rsync, který jde alespoň zopakovat. INI jde generovat tam, odkud se rsyncuje a nebo skriptem tam, kde se pouští clone/pull (případně co je cílem push, který se dá nahookovat).

Spuštění skriptu, který by nastavil hooky je sice celkem hezké, ale závisí to na uživateli (adminovi/programátorovi), takže se na to nelze spolehnout (prakticky ověřeno).

Což přesně odpovídá tomu, jak to fungovat má.

Dalším háčkem je, že používám submoduly pro pluginy, takže by to znamenalo hlídat hooky pro každý plugin. Tohle je okamžik, kdy to přestává být praktické.

Hooky pro pluginy by neměly být vůbec potřeba. Ve chvíli, kdy pushneš hlavní strom, tak není problém nechat zaktualizovat submoduly a veškerou další práci dělat z hooku hlavního stromu.

Začínám přicházet na to, že celá tvá myšlenka je postavená na takzvaném „drbání se levou nohou za pravým uchem“, ale na to časem přijdeš sám.

[Josef Kufner]

Deploy na testovacím serveru vypadá tak, že udělám push do bare repositáře, který je sdílený s ostatníma lidma. V post-update hooku je script, který udělá cd do document root na serveru, kde je klasický pracovní repositář a udělá fetch && checkout toho, co je v master větvi bare repositáře (a pak ještě submodule update).

Deploy na produkční nebo jakýkoliv další server je prakticky stejný, jen tam místo post-update hooku je člověk (admin), který to spouští ručně. Informace o verzi pak musí být k dispozici vždy, i když ten člověk zapomene nebo se vůbec nedozví, že má nějaké hooky nastavit.

Hooky pro pluginy by neměly být vůbec potřeba.

A co když se aktualizuje jen plugin? Třeba protože ho zrovna vyvíjí a udělal commit. Navíc framework samotný je jako submodul také (rodičovský repositář patří aplikaci).

[pavlix]

Informace o verzi pak musí být k dispozici vždy, i když ten člověk zapomene nebo se vůbec nedozví, že má nějaké hooky nastavit.

Nezlob se na mě, ale nastavit ty hooky není až takový problém a zabránít v zapomenutí je natolik triviální (například software úmyslně nepracuje, pokud nejsou nastavené), že si s klidem dovolím to celé označit za jednu velkou hloupou výmluvu.

A co když se aktualizuje jen plugin? Třeba protože ho zrovna vyvíjí a udělal commit.

Princip submodulů je založený právě na tom, že hlavní modul obsahuje informaci o přesné verzi (commitu) submodulů. Nemá smysl používat git submodules a přitom obcházet jejich základní princip a jedinou výhodu oproti zcela samostatným repozitářům.

Navíc framework samotný je jako submodul také (rodičovský repositář patří aplikaci).

V tom nevidím problém, pokud se celá věc dobře ošetří. Pozor na to, že submoduly nefungujou úplně hladce a úplně samy. Je to (možná bohužel) v gitu celkem pokročilý nástroj, a je potřeba se k němu podle toho chovat.

[Josef Kufner]

Jo, ono je není problém nastavit. O tom žádná. Pokud je projektů (a tím i repositářů) málo, v pohodě. Ale se stoupajícím počtem instalací (desítky) je to větší a větší otrava ... tím spíš, když je potřeba takové scripty udržovat použitelné na více platformách, byť zdánlivě skoro stejných (vždy se najde nějaký otravný detail, který je třeba opravit). Takže se prostě jen snažím minimalizovat veškerou podpůrnou infrastrukturu.

(například software úmyslně nepracuje, pokud nejsou nastavené)

Takováto kurvítka jsou mi celkem proti srsti. Obvykle píšu programy tak, aby se nenechaly rozhodit kdejakou blbostí. Představa, že mi pak chyba v této, z pohledu uživatele vcelku nepodstatné, části sundá celou aplikaci na produkčním serveru se mi moc nezamlouvá. I když na druhou stranu, být to něco důležitějšího, tak by to bylo rozumné řešení.