Siirry pääsisältöön

Git-hookien käyttäminen

Opi automatisoimaan koodin laadunvalvonta pre-commit-hookilla ja julkaisun jälkeiset toimet (kuten Composer-ajot ja välimuistien tyhjennys) post-receive-hookilla Seravon ympäristössä.

Git-hookit ovat skriptejä, joiden avulla voit suorittaa automaattisia toimintoja Git-työnkulun eri vaiheissa – esimerkiksi ennen muutosten tallentamista (commit) tai heti palvelimelle julkaisun (push) jälkeen.

Hook-skriptit sijaitsevat kunkin Git-repon paikallisessa .git/hooks/-hakemistossa. Koska .git/-hakemiston sisältö ei kuulu versionhallintaan, hookit eivät kopioidu automaattisesti git clone-, git pull- tai git push -komentojen mukana. Tämän vuoksi Seravon WordPress-projektipohjassa valmiit malliskriptit on tallennettu versionhallintaan hakemistoon scripts/git-hooks/, josta ne on helppo ottaa käyttöön.

Esivaatimukset

Ennen Git-hookien käyttöönottoa varmista, että sinulla on:

  • Paikallinen Git-kopio projektista: pre-commit-hookit asennetaan omalle työasemallesi projektin .git/hooks/-hakemistoon.

  • SSH-yhteys palvelimelle: Julkaisun yhteydessä suoritettavan post-receive-hookin luominen ja suoritusoikeuksien asettaminen (chmod +x) vaativat SSH-pääsyn palvelimen /data/wordpress/.git/hooks/-hakemistoon.

Kehityksen aikana: pre-commit-hook

Paikallinen pre-commit-hook suoritetaan työasemallasi aina, kun ajat komennon git commit. Jos skripti havaitsee virheen ja palauttaa virhekoodin, commit keskeytyy. Tämä estää esimerkiksi PHP-syntaksivirheiden päätymisen versionhallintaan.

Seravon projektipohjan malliskripti (scripts/git-hooks/pre-commit) tarkistaa automaattisesti muokattujen PHP-tiedostojen syntaksin (php -l) ennen tallennusta.

pre-commit-hookin käyttöönotto

Ota malliskripti käyttöön paikallisessa projektihakemistossasi kopioimalla se .git/hooks/-kansioon ja antamalla sille suoritusoikeudet:

cp scripts/git-hooks/pre-commit .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

Vinkki: Voit vaihtoehtoisesti määrittää Gitin käyttämään versionhallinnassa olevaa hook-hakemistoa suoraan ajamalla paikallisessa projektihakemistossasi komennon git config core.hooksPath scripts/git-hooks.

pre-commit-hookin tilapäinen ohittaminen

Jos haluat tehdä tallennuksen ohittaen paikalliset tarkistukset tilapäisesti, käytä --no-verify-valitsinta (lyhyesti -n):

git commit --no-verify -m "Väliaikainen tallennus"

Julkaisun aikana: post-receive-hook

Kun julkaiset muutoksia palvelimelle komennolla git push production master, palvelimen Git voi suorittaa automaattisesti post-receive-hookin heti tiedostojen vastaanottamisen jälkeen. Seravolla tätä hookia ei ole aktivoitu oletuksena, vaan se otetaan käyttöön projektikohtaisesti palvelimella.

Tyypillisiä käyttötapoja post-receive-hookille ovat:

  • Riippuvuuksien asentaminen: Ajetaan composer install --no-dev, jos composer.json on käytössä.

  • Koodin rakentaminen (Build): Käännetään teeman CSS- ja JavaScript-tiedostot (esim. npm run build tai gulp build).

  • Välimuistien tyhjennys: Tyhjennetään WordPressin objektivälimuisti ja nginxin sivuvälimuisti, jotta muutokset näkyvät kävijöille välittömästi.

post-receive-hookin käyttöönotto palvelimella

Ota yhteys palvelimelle SSH:lla. Jos projektisi pohjautuu Seravon WordPress-mallipohjaan, voit kopioida valmiin skriptin suoraan käyttöön:

cp /data/wordpress/scripts/git-hooks/post-receive /data/wordpress/.git/hooks/post-receive
chmod +x /data/wordpress/.git/hooks/post-receive

Vaihtoehtoisesti voit luoda oman pelkistetyn /data/wordpress/.git/hooks/post-receive-skriptin:

#!/bin/bash
set -e

echo "Suoritetaan julkaisun jälkeiset tehtävät..."

# Asenna Composer-riippuvuudet
if [ -f "/data/wordpress/composer.json" ]; then
cd /data/wordpress && composer install --no-dev --optimize-autoloader
fi

# Tyhjennä WordPressin objektivälimuisti ja nginx-sivuvälimuisti
wp cache flush --path=/data/wordpress/htdocs
wp-purge-cache

Muista antaa itse luodulle tiedostolle suoritusoikeudet komennolla:

chmod +x /data/wordpress/.git/hooks/post-receive

Hookien testaaminen

Koska Git-hookit ovat tavallisia komentotulkkiskriptejä, voit testata niiden toimintaa ajamalla ne suoraan komentoriviltä ilman uutta commitia tai push-julkaisua.

Palvelimen post-receive-hookin voi testata SSH-yhteyden kautta komennolla:

/data/wordpress/.git/hooks/post-receive

Esimerkki onnistuneesta ajosta:

Seravo: running post-receive git hook
Seravo: composer.json was updated, installing...
Loading composer repositories with package information
Installing dependencies from lock file
Nothing to install or update
Seravo: SASS files changed, running Gulp...
[22:14:20] Finished 'sass' after 270 ms
Seravo: Flushing all caches...
----> Purging WordPress object cache...
Success: The cache was flushed.
----> Purging Nginx page cache...
Cache purged successfully.

Vastaavasti paikallisen pre-commit-hookin voi testata työasemalla ajamalla projektihakemistossa .git/hooks/pre-commit.

Yleisimmät virhetilanteet

  • Hook-skripti ei suoritu lainkaan git commit- tai git push -komennon yhteydessä: Varmista, että tiedostonimi on kirjoitettu täsmälleen oikein ilman tiedostopäätettä (pre-commit tai post-receive) ja että tiedostolla on suoritusoikeudet (chmod +x).

  • Hook epäonnistuu virheeseen bad interpreter: No such file or directory: Tiedosto on todennäköisesti tallennettu Windowsin rivinvaihdoilla (CRLF). Muunna rivinvaihdot Unix-muotoon (LF) esimerkiksi komennolla sed -i 's/\r$//' /data/wordpress/.git/hooks/post-receive.

  • Hook lakkasi toimimasta, kun projekti kloonattiin uudelle koneelle: Git ei kopioi .git/hooks/-hakemiston sisältöä kloonauksen yhteydessä. Kopioi hook uudelleen scripts/git-hooks/-kansiosta .git/hooks/-hakemistoon ja anna sille suoritusoikeudet.

  • git push onnistui, vaikka post-receive-skriptin sisäinen komento epäonnistui: post-receive ajetaan vasta sen jälkeen, kun Git on jo vastaanottanut tiedostot. Tarkista git push -tulosteessa näkyvät remote:-alkuiset virheilmoitukset, korjaa virhe palvelimella ja testaa skripti uudelleen ajamalla /data/wordpress/.git/hooks/post-receive.

Katso myös

Git-hookien avulla pidät koodin laadun tasaisena ja automatisoit julkaisun rutiinitehtävät luotettavasti. Mikäli tarvitset apua hook-skriptien käyttöönotossa tai julkaisuautomaation määrittämisessä, asiakaspalvelumme auttaa osoitteessa [email protected].

Vastasiko tämä kysymykseesi?