Uvajanje mesta Blockstudio
Za bloke zadostuje kopiranje mape teme na strežnik: Blockstudio jih odkrije v datotečnem sistemu, njegovi predpomnilniki pa sami zaznajo spremenjene vhode. Pravo mesto ima več premičnih delov. Strani iz datotek dosežejo zbirko podatkov šele, ko jih sinhronizirate. Statično vnaprej izrisana stran še naprej prikazuje včerajšnji HTML, dokler ga nekaj ne zamenja. Pred njo postavljeni CDN še naprej prikazuje vsebino iz svojega predpomnilnika.
Ta vodnik pripravi uvajanje teme z imenom acme, ki združuje Blockstudio
prek Composer. Opisuje, kaj se izvaja v CI, kaj se izvede na strežniku po prenosu
datotek, kako brati poročilo o sinhronizaciji strani in kateri ukazi wp bs
sodijo v izdajo.
Izdaja v enem prikazu
- Gradnja. CI namesti produkcijske odvisnosti Composer.
- Nalaganje. Tema, vključno z
vendor/, prispe na strežnik. - Uskladitev strani.
wp bs pages syncuskladi objave strani z datotekami in izpiše poročilo. - Osvežitev predpomnilnika izvora. Shranjeni HTML se počisti, če so se strani spremenile, nato pa se znova napolni.
- Počisti CDN. Nazadnje, da se robno vozlišče napolni iz svežega izvora.
Koraka 3 in 4 na strežniku potrebujeta WP-CLI. Spodnji skript uporablja tudi jq za branje JSON.
1. korak: Composer v CI
Vključite Blockstudio v temo in potrdite composer.lock, da CI namesti natančno različico, ki ste jo preizkusili:
{
"require": {
"blockstudio/blockstudio": "^7.0"
}
}
<?php
require_once __DIR__ . '/vendor/autoload.php';
V CI namestite brez razvojnih paketov:
composer install --no-dev --optimize-autoloader --no-interaction --prefer-dist
Blockstudio se zažene prek samodejnega nalagalnika, njegove lastne odvisnosti izvajalnega okolja pa so vključene v paket in imajo lasten imenski prostor. Ko se naloži iz imenika vendor/, je vgrajeni posodabljalnik GitHub onemogočen, zato je Composer edini način za spremembo različice.
2. korak: Določite, kaj mora biti zapisljivo
Blockstudio med izvajanjem zapisuje ustvarjene datoteke. Preden uvedba zamenja ali zaklene imenik, preverite, kam jih zapisuje:
- Predpomnilniki izvajalnega okolja so privzeto v
wp-content/blockstudio/cache/. Če želite, usmeritecache.pathna namenski zapisljivi nosilec. Ob spremembi poti se predpomnilnik začne polniti znova. - Prevedena sredstva blokov so privzeto zapisana v mapo
_distob vsakem bloku. Če je imenik izdaje samo za branje ali se ob vsaki uvedbi zamenja, nastaviteassets.outputnacache, da se zapišejo v imenik predpomnilnika:
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"assets": {
"output": "cache"
}
}
Ob uvedbi vam ni treba počistiti predpomnilnikov. Vsak vnos predpomnilnika je vezan na svoje vhodne podatke, vključno z datotekami blokov, nastavitvami, aktivno temo in vtičniki ter različicami WordPress, PHP in Blockstudio, zato izdaja, ki jih spremeni, dobi nove ključe. V production in staging Blockstudio 20 sekund zaupa preverjenemu posnetku spremljanja, preden znova preveri datoteke, zato lahko zaznava spremembe zamuja do 20 sekund. Filter blockstudio/cache/watch_debounce spremeni to časovno okno.
3. korak: Uskladitev strani
Objave strani se spremenijo samo z izrecno sinhronizacijo. Zahteve za frontend, skrbništvo, Ajax, REST, cron in običajne WP-CLI nikoli ne odkrijejo virov strani ali zapišejo objav strani. Uvedba mora to izrecno zahtevati:
wp bs pages sync --format=json
Na spletnem mestu, katerega tema ima dve strani, about in contact, ju prvi zagon ustvari:
{
"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": []
}
Kako razumeti izpis:
created,updated,unchanged,removedinfailedštejejo strani. Če se prstni odtis vira strani ni spremenil, se objava in metapodatki objave ne zapišejo, sprožijo pa se tudi nobene posodobitvene kljuke.- Vsak prehod primerja celoten seznam strani.
fullReconciliationpove, ali se prehod šteje za popolno uskladitev:trueob prvem zagonu, z--fullali ob spremembi samega mehanizma za sinhronizacijo terfalse, kadar obstaja identiteta iz prejšnje uspešne sinhronizacije. Nadaljnja orodja lahko s tem določijo, ali morajo vse znova zgraditi. sourceIdentityje deterministični prstni odtis seznama strani in mehanizma za sinhronizacijo. Ukaz ga shrani po uspešnem prehodu.
Brez --format=json ukaz izpiše eno vrstico s povzetkom in sporočilo o uspehu. V dnevniku CI, ki ni terminal, so stolpci ločeni s tabulatorji:
discovered created updated unchanged removed failed source_id
2 0 1 1 0 0 7bd575b4ee6c0a948f439dd83ce5fa403f8113c9406c3b13b6ade2f2b19f3c2c
Success: File-backed pages synchronized.
Ta zagon je sledil urejanju about/index.php: ena stran je bila posodobljena, ena pa nespremenjena.
Ko sinhronizacija ne uspe
Ukaz se konča s statusom 1, če odkrivanje ali usklajevanje javi napako, zato korak CI spodleti. Poročilo JSON se vseeno izpiše, zato ga zabeležite. Nepravilno oblikovan page.json je videti takole:
{
"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"
}
}
]
}
Upravljane strani, katerih viri so izginili, se odstranijo šele po zaključku prehoda brez napak, zato neuspešna sinhronizacija ob izdaji ne izbriše aktivnih strani. Odstranjene strani se privzeto premaknejo v koš; filter blockstudio/pages/orphan_action lahko vrne trash, delete ali keep.
Zaženite ob vsaki uvedbi
Sinhronizacijo zaženite tudi, kadar se ni spremenila nobena stran. Če uvajate v imenike izdaj in preklopite simbolno povezavo, nespremenjena stran še vedno kaže na poti predloge in postavitve iz prejšnje izdaje, dokler jih ne osveži naslednja sinhronizacija. Ta osvežitev ne spremeni post_content ali datuma spremembe.
--authoritative in --full
Običajna sinhronizacija ohrani vsebino, ki so jo uredniki spremenili znotraj blokov s ključi. --authoritative namesto tega zamenja upravljano vsebino z vsebino iz datotek in lahko odstrani zaklep Page Sync. Uporabite ga, kadar morajo obveljati datoteke: pri ponastavitvi testnega spletnega mesta ali na spletnem mestu, kjer nihče ne ureja strani, vezanih na datoteke, v urejevalniku. Ne vključite ga v vsako uvedbo spletnega mesta z aktivnimi uredniki.
--full označi prehod kot popolno uskladitev ne glede na shranjeno identiteto. Primerjava strani je že pri vsakem prehodu popolna, zato zastavica v poročilu spremeni fullReconciliation, ne pa tega, katere strani se preverijo. Podajte jo, kadar naslednji korak na podlagi te vrednosti sproži celotno ponovno gradnjo.
Orodja, napisana v PHP, lahko neposredno pokličejo Blockstudio\Pages::reconcile(). Vrne enako poročilo, vendar ne shrani identitete: pokličite Blockstudio\Pages::store_successful_source_identity(), ko je preverjen preostanek izdaje, na primer aktiviran statični artefakt.
4. korak: Osvežitev statičnega predpomnilnika
Če spletno mesto uporablja statično predizrisovanje v privzetem načinu signature, objave strani, posodobljene iz WP-CLI, same ne počistijo shranjenega HTML. Preberite poročilo in počistite predpomnilnik, če se je karkoli spremenilo, nato pa ga napolnite:
#!/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}'
Vsak zagon wp bs prerender warm doda zastarele javne URL-je v čakalno vrsto, izriše največ warm.concurrency od njih in izpiše povzetek. V tem prehodu so bili obdelani štirje od šestih URL-jev v čakalni vrsti, izris vseh štirih pa je spodletel:
{"queued":6,"processed":4,"warmed":0,"skipped":0,"failed":4}
URL, pri katerem izris spodleti, ostane zastarel in je ob naslednjem zagonu znova dodan v čakalno vrsto. Zato se zanka ustavi ob prvem prehodu, ki ničesar ne napolni, namesto da bi čakala na prazno vrsto. Vse preostalo prevzame načrtovano orodje za polnjenje ali naslednji anonimni obisk.
V načinu graph je orodje za polnjenje za vsak URL izklopljeno, warm pa ne doda ničesar v čakalno vrsto. Grafna spletna mesta koraka 2 in 3 nadomestijo z lastno gradnjo, ki izriše prizadete URL-je in atomsko aktivira rezultat. Oglejte si načina s podpisom in grafom.
5. korak: Potek CI
Spodnji potek je primer za GitHub Actions. Enako zasnovo lahko uporabite v katerem koli sistemu CI: gradnja, nalaganje, zagon skripta na strežniku, čiščenje CDN.
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 }}"
concurrency z cancel-in-progress: false postavi drugo potiskanje v čakalno vrsto za uvajanje, ki že poteka, namesto da bi ga preklicalo sredi sinhronizacije. PHP 8.2 je najnižja različica za Blockstudio. Zadnji korak zamenjajte s svojim CDN čiščenja API.
Ukazi za vzdrževanje
Ti ukazi ne sodijo v vsako izdajo, vendar jih mora poznati postopek za uvedbo.
Praznjenje čakalne vrste zastarelih zaklepov. Izdaje pred 7.6.14 so ob vsaki spremembi vsebine pustile datoteko .build.lock. Po nadgradnji jih WP-Cron odstranjuje v omejenih paketih. Za preverjanje in takojšnje praznjenje čakalne vrste:
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).
cleanup pusti zaklepe, mlajše od ene ure, ali zaklepe, ki jih še drži zahteva v izvajanju, do naslednjega prehoda. Med delovanjem spletnega mesta nikoli ročno ne brišite datotek zaklepa.
Čiščenje predpomnilnika izvajalnega okolja. wp bs cache clear počisti vse za trenutno spletno mesto, wp bs cache clear --scope=runtime pa počisti eno področje v vseh imenskih prostorih. Naslednja zahteva bo predpomnilnik znova napolnila, zato ukaz zaženite ob manjšem prometu in le, če za to obstaja razlog: spremembe vhodnih podatkov že zamenjajo ključe.
Odstranjevanje Blockstudio. Namestitev Composer nima kljuke za deaktivacijo vtičnika, zato ob odstranitvi paketa nič ne odstrani dogodkov cron iz urnika ali zgodaj naloženega dodatka za strežbo. To zaženite pred odstranitvijo odvisnosti:
wp bs teardown
Odstrani dogodke cron in stanje statičnega predizrisovanja, ki ga upravlja ta namestitev, pusti tuje dodatke in konfiguracijske datoteke nedotaknjene ter omogoči čist ponovni vklop.
Naslednji koraki
- Gradnja strani iz datotek: strani, ki jih uskladi ta uvedba.
- Referenca strani: vedenje sinhronizacije, PHPuskladitevAPI in pogodba o identiteti uvedbe.
- ReferencaCLI: vsi ukazi
wp bs. - Predpomnjenje: mesto predpomnilnika, identiteta, hramba in čakalna vrsta zaklepov.
- Strežba WordPress kot statičnega HTML: predpomnilnik, ki se osveži v 4. koraku.
- Composer: namestitve kot vtičnik, obvezni vtičnik, tema in paket vtičnika.