Blockstudio webhely telepítése
A blokkokhoz elég átmásolni a sablonmappát a szerverre: a Blockstudio felismeri a fájlrendszerből, a gyorsítótárai pedig maguktól észreveszik a megváltozott bemeneteket. Egy éles webhelyen több mindenre kell figyelni. A fájlalapú oldalak csak szinkronizálás után kerülnek az adatbázisba. Egy statikus előzetes renderelés tegnapi HTML tartalmat jelenít meg addig, amíg le nem cseréli valami. Az előtte álló CDN pedig azt szolgálja ki, amit gyorsítótárazott.
Ez az útmutató egy acme nevű sablonhoz készít telepítési folyamatot, amely a Composer segítségével csomagolja a Blockstudio elemet. Bemutatja, mi fut a CI-ben, mi fut a szerveren a fájlok megérkezése után, hogyan kell olvasni az oldalszinkronizálási jelentést, és mely wp bs parancsok tartoznak egy kiadáshoz.
A kiadás egyetlen ábrán
- Build. A CI telepíti az éles Composer függőségeket.
- Feltöltés. A téma, benne a
vendor/fájllal, felkerül a szerverre. - Oldalak egyeztetése. A
wp bs pages syncösszehangolja az oldalbejegyzéseket a fájlokkal, és jelentést ír ki. - Az eredeti gyorsítótár frissítése. A tárolt HTML gyorsítótár kiürül, ha változtak az oldalak, majd újra feltöltődik.
- A CDN gyorsítótár ürítése. Utolsó lépésként, hogy a peremhálózat friss eredetiből tölthesse fel.
A 3. és 4. lépéshez WP-CLI szükséges a szerveren. Az alábbi szkript a jq segítségével olvassa be a JSON fájlt is.
1. lépés: Composer a CI-ben
Csomagolja a Blockstudio elemet a témába, és véglegesítse a composer.lock fájlt, hogy a CI a tesztelt pontos verziót telepítse:
{
"require": {
"blockstudio/blockstudio": "^7.0"
}
}
<?php
require_once __DIR__ . '/vendor/autoload.php';
A CI-ben telepítsen fejlesztői csomagok nélkül:
composer install --no-dev --optimize-autoloader --no-interaction --prefer-dist
A Blockstudio az autoloaderből indul, futásidejű függőségei pedig a csomagban vannak összevonva és névtérbe zárva. Ha vendor/ könyvtárból töltődik be, a beépített GitHub frissítő le van tiltva, így a verzió módosításának egyetlen módja a Composer marad.
2. lépés: Döntse el, minek kell írhatónak lennie
A Blockstudio futás közben generált fájlokat ír. Mielőtt egy telepítés lecserél vagy zárol egy könyvtárat, tudja meg, hová ír:
- A futásidejű gyorsítótárak alapértelmezés szerint a
wp-content/blockstudio/cache/alatt találhatók. Ha szeretné, állítsa acache.pathértékét egy külön írható kötetre. Az útvonal módosításakor a gyorsítótár üres lesz. - A lefordított blokkeszközök alapértelmezés szerint minden blokk mellett egy
_distmappába kerülnek. Ha a kiadási könyvtár csak olvasható, vagy minden telepítéskor lecserélődik, állítsa aassets.outputértékét erre:cache. Így ezek inkább a gyorsítótár könyvtárába kerülnek:
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"assets": {
"output": "cache"
}
}
Telepítéskor nem kell törölnie a gyorsítótárakat. Minden gyorsítótár-bejegyzés kulcsa a bemeneteitől függ, beleértve a blokkfájlokat, a beállításokat, az aktív témát és bővítményeket, valamint a WordPress, PHP és Blockstudio verzióját, így a változásokat tartalmazó kiadás új kulcsokat kap. production és staging esetén a Blockstudio 20 másodpercig megbízik az érvényesített figyelési pillanatképben, mielőtt újra ellenőrzi a fájlokat, ezért akár 20 másodpercbe is telhet, mire észreveszi a változást. Ezt az időtartamot a blockstudio/cache/watch_debounce szűrő módosítja.
3. lépés: Oldalak egyeztetése
Az oldalbejegyzések csak kifejezett szinkronizáláskor változnak. A frontend, az adminisztráció, az Ajax, a REST, a cron és a szokásos WP-CLI kérések soha nem keresik meg az oldalak forrásait, és nem írnak oldalbejegyzéseket. A telepítésnek kell kezdeményeznie:
wp bs pages sync --format=json
Egy olyan webhelyen, amelynek témája két oldalt tartalmaz, a about és a contact oldalt, az első futtatás létrehozza őket:
{
"discovered": 2,
"created": 2,
"updated": 0,
"unchanged": 0,
"removed": 0,
"failed": 0,
"fullReconciliation": true,
"sourceId": "f88baddfd5a1deb94eb8c9bbeca10d5a0d47a72f16b50efdb25a7127945af7dd",
"sourceIdentity": {
"commit": "",
"dirtyHash": "",
"inventoryHash": "aaec5b9dd13d74eea872117b6167caa7a5d5c1abad9572fba22f6ddf6340adfe",
"engineFingerprint": "2c442442bb49f91e7187560e6db8f3475caa0b62b47708cab95b6ff13aba4469",
"hash": "f88baddfd5a1deb94eb8c9bbeca10d5a0d47a72f16b50efdb25a7127945af7dd"
},
"pages": {
"about": {
"status": "created",
"postId": 545,
"locked": false
},
"contact": {
"status": "created",
"postId": 546,
"locked": false
}
},
"errors": []
}
A jelentés értelmezése:
- A
created,updated,unchanged,removedésfailedaz oldalak számát mutatják. Ha egy oldal forrásának ujjlenyomata nem változott, a rendszer nem ír bejegyzést vagy bejegyzésmetaadatot, és nem futtat frissítési hookokat. - Minden menet összeveti az oldalak teljes leltárát. A
fullReconciliationjelzi, hogy teljes egyeztetésnek számít-e a menet: ez az első futtatáskor,trueesetén vagy ha maga a szinkronizáló motor változott,--full; korábbi sikeres szinkronizálásból származó azonosító esetén pedigfalse. A további eszközök ez alapján dönthetik el, hogy mindent újra kell-e építeni. - A
sourceIdentityaz oldalak leltárának és a szinkronizáló motornak determinisztikus ujjlenyomata. A parancs sikeres menet után elmenti.
--format=json nélkül a parancs egy összesítő sort és egy sikerüzenetet ír ki. A CI naplójában, amely nem terminál, a sor tabulátorral elválasztott:
discovered created updated unchanged removed failed source_id
2 0 1 1 0 0 7bd575b4ee6c0a948f439dd83ce5fa403f8113c9406c3b13b6ade2f2b19f3c2c
Success: File-backed pages synchronized.
Ez a futtatás a about/index.php módosítása után történt: egy oldal frissült, egy változatlan maradt.
Ha a szinkronizálás sikertelen
A parancs 1-es állapotkóddal lép ki, ha a felderítés vagy az egyeztetés hibát jelez, így a CI-lépés meghiúsul. A JSON jelentés ettől még megjelenik, ezért mentse el a naplóban. Egy hibás page.json így néz ki:
{
"discovered": 0,
...
"failed": 1,
...
"pages": [],
"errors": [
{
"code": "invalid_page_json",
"message": "Invalid page.json file.",
"context": {
"path": ".../wp-content/themes/acme/pages/pricing/page.json"
}
}
]
}
A forrásukból eltűnt, felügyelt oldalak csak akkor törlődnek, ha a menet hiba nélkül befejeződött, így egy sikertelen szinkronizálású kiadás nem teszi tönkre az élő oldalakat. Az eltávolított oldalak alapértelmezés szerint a kukába kerülnek; a blockstudio/pages/orphan_action szűrő visszaadhatja a trash, delete vagy keep értéket.
Futtassa minden telepítéskor
Akkor is futtassa a szinkronizálást, ha egyetlen oldal sem változott. Ha kiadási könyvtárakba telepít, és egy szimbolikus hivatkozást vált át, egy változatlan oldal továbbra is az előző kiadás sablon- és elrendezési útvonalaira mutat, amíg a következő szinkronizálás nem frissíti ezeket. A frissítés nem módosítja a post_content értékét vagy a módosítás dátumát.
--authoritative és --full
A szokásos szinkronizálás megőrzi a szerkesztők által a kulcsos blokkokban módosított tartalmat. A --authoritative ehelyett a fájlokból származó, felügyelt tartalmat írja be, és feloldhat egy Oldalszinkronizálási zárolást. Akkor használja, ha a fájloknak kell felülírniuk a tartalmat, például egy tesztkörnyezet visszaállításakor, vagy olyan webhelyen, ahol senki nem szerkeszti a fájlalapú oldalakat a szerkesztőben. Ne használja minden telepítéskor olyan webhelyen, ahol aktív szerkesztők dolgoznak.
A --full a tárolt azonosítótól függetlenül teljes egyeztetésként jelöli meg a menetet. Mivel az oldalak összehasonlítása minden menetben teljes, a jelző csak a jelentés fullReconciliation értékét módosítja, az ellenőrzött oldalak körét nem. Adja meg, ha egy későbbi lépés az érték alapján teljes újraépítést indít.
A PHP nyelven írt eszközök közvetlenül meghívhatják a Blockstudio\Pages::reconcile() elemet. Ugyanazt a jelentést adja vissza, de nem menti el az azonosítót: csak akkor hívja meg a Blockstudio\Pages::store_successful_source_identity() elemet, ha ellenőrizte a kiadás többi részét, például az aktivált statikus összetevőt.
4. lépés: A statikus gyorsítótár frissítése
Ha a webhely az alapértelmezett signature módban használja a statikus előrenderelést, a WP-CLI által frissített oldalbejegyzések nem ürítik ki maguktól a tárolt HTML-t. Olvassa el a jelentést, és ürítse ki a gyorsítótárat, ha bármi változott, majd melegítse be:
#!/usr/bin/env bash
set -euo pipefail
cd /var/www/example.com
report=$(mktemp)
# 1. Reconcile file-backed pages and keep the report.
if ! wp bs pages sync --format=json > "$report"; then
cat "$report"
exit 1
fi
jq '{discovered, created, updated, unchanged, removed}' "$report"
# 2. Drop stored HTML when page content changed.
changed=$(jq '.created + .updated + .removed' "$report")
if [ "$changed" -gt 0 ]; then
wp bs prerender purge
fi
# 3. Re-warm in bounded passes until a pass warms nothing.
for _ in $(seq 1 50); do
warmed=$(wp bs prerender warm | jq '.warmed')
[ "$warmed" -gt 0 ] || break
done
wp bs prerender status | jq '{files, queue}'
Minden wp bs prerender warm futtatás sorba állítja az elavult nyilvános URL-eket, legfeljebb warm.concurrency darabot renderel, és összefoglalót ír ki. Ebben a menetben a sorban álló hat URL-ből négyet vett át, és mind a négy renderelése sikertelen volt:
{"queued":6,"processed":4,"warmed":0,"skipped":0,"failed":4}
A renderelés közben meghiúsuló URL elavult marad, és a következő futtatáskor ismét sorba kerül. Ezért áll le a ciklus az első olyan menet után, amely semmit nem frissített, ahelyett hogy üres sorra várna. A fennmaradó elemekkel az ütemezett gyorsítótár-feltöltő vagy a következő névtelen látogatás foglalkozik.
graph módban az egyes URL-ekhez tartozó gyorsítótár-feltöltő ki van kapcsolva, és a warm nem állít sorba semmit. A gráfalapú webhelyek a 2. és 3. lépést saját buildfolyamattal váltják ki, amely megjeleníti az érintett URL-eket, és atomikusan aktiválja az eredményt. Lásd az aláírási és gráfmódokat.
5. lépés: A CI-munkafolyamat
Az alábbi munkafolyamat egy GitHub Actions példa. A felépítése bármely CI-rendszerre alkalmazható: build, feltöltés, a szkript futtatása a szerveren, majd a CDN ürítése.
name: Deploy
on:
push:
branches: [main]
concurrency:
group: deploy-production
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-latest
environment: production
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
php-version: "8.2"
tools: composer:v2
- name: Install production dependencies
run: composer install --no-dev --optimize-autoloader --no-interaction --prefer-dist
- name: Configure SSH
run: |
mkdir -p ~/.ssh
echo "${{ secrets.DEPLOY_KEY }}" > ~/.ssh/id_ed25519
chmod 600 ~/.ssh/id_ed25519
ssh-keyscan example.com >> ~/.ssh/known_hosts
- name: Upload the theme
run: |
rsync -az --delete --exclude ".git" --exclude ".github" \
./ deploy@example.com:/var/www/example.com/wp-content/themes/acme/
- name: Sync pages and refresh the static cache
run: ssh deploy@example.com 'bash -s' < scripts/post-deploy.sh
- name: Purge the CDN
run: curl -fsS -X POST "${{ secrets.CDN_PURGE_URL }}"
A concurrency cancel-in-progress: false használatával a futó telepítés mögé egy második feltöltés kerül a sorba, ahelyett hogy félbeszakítaná a szinkronizálást. A PHP 8.2 a Blockstudio minimális verziója. Az utolsó lépést cserélje le a CDN gyorsítótár-ürítési API műveletére.
Karbantartási parancsok
Ezek nem valók minden kiadásba, de a telepítési útmutatónak ismernie kell őket.
A régi zárolási sor kiürítése. A 7.6.14 előtti kiadások minden tartalommódosítás után hátrahagytak egy .build.lock fájlt. Frissítés után a WP-Cron korlátozott méretű adagokban eltávolítja ezeket. A sor ellenőrzéséhez és egyszeri kiürítéséhez:
wp bs cache status
wp bs cache cleanup
0 legacy build lock(s) across 0 cache namespace(s).
Next cleanup batch in 0 second(s).
A cleanup a következő menetben hagyja eltávolítás nélkül az egy óránál újabb, illetve a futó kérés által még használt zárolásokat. Amíg a webhely forgalmat szolgál ki, soha ne töröljön kézzel zárolási fájlokat.
A futásidejű gyorsítótár törlése. A wp bs cache clear kiüríti az aktuális webhely teljes gyorsítótárát, a wp bs cache clear --scope=runtime pedig egyetlen hatókört ürít ki az összes névtérben. A következő kérés üres gyorsítótárat épít újra, ezért kis forgalmú időszakban futtassa, és csak indokolt esetben: a bemenetek változásakor a kulcsok egyébként is lecserélődnek.
A Blockstudio eltávolítása. Egy Composer telepítésnek nincs bővítmény-deaktiválási hookja, ezért a csomag eltűnésekor semmi sem törli az ütemezett cron eseményeket vagy távolítja el a korai kiszolgálást végző drop-int. A függőség eltávolítása előtt futtassa ezt:
wp bs teardown
Eltávolítja a telepítéshez tartozó cron eseményeket és a statikus előzetes renderelés állapotát, érintetlenül hagyja az idegen drop-in fájlokat és konfigurációkat, és lehetővé teszi a tiszta újbóli bekapcsolást.
Következő lépések
- Fájlalapú oldalak létrehozása: az oldalak, amelyeket ez a telepítés egyeztet.
- Oldalreferencia: a szinkronizálás működése, az PHP egyeztetési API és a telepítési azonosítóra vonatkozó szerződés.
- CLI referencia: az összes
wp bsparancs. - Gyorsítótárazás: a gyorsítótár helye, azonosítója, megőrzése és a zárolási sor.
- WordPress kiszolgálása statikus HTML-ként: a gyorsítótár, amelyet a 4. lépés frissít.
- Composer: bővítményként, kötelező használatúként, témaként és bővítménybe csomagolva történő telepítés.