Distribuera en Blockstudio-webbplats
Det räcker att kopiera en temamapp till en server för block: Blockstudio hittar dem i filsystemet, och dess cache upptäcker själv när indata ändras. En riktig webbplats har fler delar. Filbaserade sidor når databasen först när du synkar dem. En statisk förhandsrendering fortsätter att visa gårdagens HTML tills något ersätter den. En CDN framför webbplatsen fortsätter att visa det som den har cachelagrat.
Den här guiden bygger en driftsättning för ett tema som heter acme och paketerar Blockstudio
via Composer. Den går igenom vad som körs i CI, vad som körs på servern när
filerna har kopierats dit, hur rapporten för sidsynkronisering läses och vilka wp bs-kommandon
som hör hemma i en release.
Releaseprocessen i en bild
- Bygg. CI installerar produktionsberoenden Composer.
- Ladda upp. Temat, inklusive
vendor/, skickas till servern. - Synkronisera sidor.
wp bs pages syncsynkroniserar sidinläggen med filerna och skriver ut en rapport. - Uppdatera ursprungscachen. Lagrad HTML rensas när sidor har ändrats och fylls sedan på igen.
- Rensa CDN. Sist, så att edge-cachen fylls på från en uppdaterad ursprungscache.
Steg 3 och 4 kräver WP-CLI på servern. Skriptet nedan använder också jq för att läsa JSON.
Steg 1: Composer i CI
Paketera Blockstudio i temat och checka in composer.lock, så att CI installerar den exakta versionen du har testat:
{
"require": {
"blockstudio/blockstudio": "^7.0"
}
}
<?php
require_once __DIR__ . '/vendor/autoload.php';
Installera utan utvecklingspaket i CI:
composer install --no-dev --optimize-autoloader --no-interaction --prefer-dist
Blockstudio startar från autoloadern, och dess egna runtimeberoenden är paketerade och namnrymdsindelade i paketet. När det laddas från en vendor/-katalog är den inbyggda GitHub-uppdateraren inaktiverad, så Composer förblir det enda sättet att ändra versionen.
Steg 2: Avgör vad som måste vara skrivbart
Blockstudio skriver genererade filer vid körning. Ta reda på var innan en driftsättning ersätter eller låser en katalog:
- Runtimecachar finns som standard under
wp-content/blockstudio/cache/. Pekacache.pathpå en särskild skrivbar volym om du föredrar det. En ändrad sökväg innebär en tom cache. - Kompilerade blocktillgångar skrivs som standard till en
_dist-mapp bredvid varje block. Om din versionskatalog är skrivskyddad eller ersätts vid varje driftsättning anger duassets.outputsomcacheså att de i stället hamnar i cachekatalogen:
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"assets": {
"output": "cache"
}
}
Du behöver inte rensa cachar vid driftsättning. Varje cachepost är nycklad efter sina indata, inklusive blockfiler, inställningar, det aktiva temat och tilläggen samt versionerna WordPress, PHP och Blockstudio, så en version som ändrar dem får nya nycklar. I production och staging litar Blockstudio på en validerad ögonblicksbild från bevakningen i 20 sekunder innan filerna kontrolleras igen, så det kan ta upp till 20 sekunder att upptäcka en ändring. Filtret blockstudio/cache/watch_debounce ändrar det intervallet.
Steg 3: Synkronisera sidor
Sidinlägg ändras endast genom en uttrycklig synkronisering. Frontend-, admin-, Ajax-, REST-, cron- och vanliga WP-CLI-förfrågningar hittar aldrig sidkällor eller skriver sidinlägg. Driftsättningen måste begära det:
wp bs pages sync --format=json
På en webbplats vars tema har två sidor, about och contact, skapar den första körningen dem:
{
"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": []
}
Så här läser du resultatet:
created,updated,unchanged,removedochfailedräknar sidor. Om en sidas källfingeravtryck inte har ändrats skrivs inga inlägg eller inläggsmetadata och inga uppdateringshooks körs.- Varje körning jämför hela sidinventeringen.
fullReconciliationanger om körningen räknas som en fullständig synkronisering:truevid den första körningen, med--full, eller när själva synkmotorn har ändrats, ochfalsenär en identitet från en tidigare lyckad synkronisering finns. Nedströmsverktyg kan använda det för att avgöra om allt ska byggas om. sourceIdentityär ett deterministiskt fingeravtryck av sidinventeringen och synkmotorn. Kommandot sparar det efter en lyckad körning.
Utan --format=json skriver kommandot ut en sammanfattningsrad och en bekräftelse på att det lyckades. I en CI-logg, som inte visas i en terminal, är raden tabulatorseparerad:
discovered created updated unchanged removed failed source_id
2 0 1 1 0 0 7bd575b4ee6c0a948f439dd83ce5fa403f8113c9406c3b13b6ade2f2b19f3c2c
Success: File-backed pages synchronized.
Den körningen följde på en ändring av about/index.php: en sida uppdaterades, en förblev oförändrad.
När synkroniseringen misslyckas
Kommandot avslutas med status 1 när identifiering eller synkronisering rapporterar ett fel, vilket gör att CI-steget misslyckas. Rapporten JSON skrivs ändå ut, så spara den i loggen. En felaktigt utformad page.json ser ut så här:
{
"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"
}
}
]
}
Hanterade sidor vars källor har försvunnit tas bort först efter att en körning slutförts utan fel, så en driftsättning som misslyckas med synkroniseringen förstör inte aktiva sidor. Borttagna sidor flyttas som standard till papperskorgen; filtret blockstudio/pages/orphan_action kan returnera trash, delete eller keep.
Kör vid varje driftsättning
Kör synkroniseringen även när ingen sida har ändrats. Om du driftsätter i versionskataloger och byter en symbolisk länk pekar en oförändrad sida fortfarande på den föregående versionens mall- och layoutssökvägar tills nästa synkronisering uppdaterar dem. Den uppdateringen påverkar inte post_content eller ändringsdatumet.
--authoritative och --full
En vanlig synkronisering bevarar innehåll som redaktörer har ändrat i nycklade block. --authoritative ersätter i stället hanterat innehåll med innehållet från filerna och kan rensa ett Page Sync-lås. Använd det när filerna ska ha företräde: när en testwebbplats återställs eller på en webbplats där ingen redigerar filbaserade sidor i redigeraren. Använd det inte vid varje driftsättning på en webbplats med aktiva redaktörer.
--full markerar körningen som en fullständig synkronisering oavsett vilken identitet som har sparats. Jämförelsen av sidor är redan fullständig vid varje körning, så flaggan ändrar fullReconciliation i rapporten, inte vilka sidor som kontrolleras. Skicka med den när ett senare steg använder det värdet för att utföra en fullständig ombyggnad.
Verktyg skrivna i PHP kan anropa Blockstudio\Pages::reconcile() direkt. Det returnerar samma rapport, men sparar inte identiteten: anropa Blockstudio\Pages::store_successful_source_identity() när resten av versionen, till exempel en aktiverad statisk artefakt, har verifierats.
Steg 4: Uppdatera den statiska cachen
Om webbplatsen använder statisk förhandsrendering i standardläget signature, rensar sidinlägg som uppdaterats från WP-CLI inte lagrad HTML automatiskt. Läs rapporten och rensa cachen om något har ändrats, och fyll sedan på den:
#!/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}'
Varje wp bs prerender warm-körning lägger till inaktuella offentliga URL:er i kön, renderar upp till warm.concurrency av dem och skriver ut en sammanfattning. I den här körningen hämtades fyra av sex köade URL:er, och alla fyra kunde inte renderas:
{"queued":6,"processed":4,"warmed":0,"skipped":0,"failed":4}
En URL som inte kan renderas förblir inaktuell och läggs i kön igen vid nästa körning. Därför stannar loopen vid den första körningen som inte värmer upp något, i stället för att vänta på en tom kö. Schemalagd cacheuppvärmning eller nästa anonyma besök tar hand om eventuella återstående URL:er.
I läget graph är cacheuppvärmning per URL avstängd, och warm lägger inte till något i kön. Grafwebbplatser ersätter steg 2 och 3 med sin egen byggprocess, som renderar berörda URL:er och aktiverar resultatet atomiskt. Se signatur- och graflägen.
Steg 5: CI-arbetsflödet
Arbetsflödet nedan är ett exempel för GitHub Actions. Upplägget fungerar också i andra CI-system: bygg, ladda upp, kör skriptet på servern och rensa 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 med cancel-in-progress: false lägger en andra publicering i kö bakom en pågående driftsättning i stället för att avbryta den mitt i en synkronisering. PHP 8.2 är den lägsta versionen för Blockstudio. Ersätt det sista steget med din CDN-caches rensnings-API.
Underhållskommandon
Dessa hör inte hemma i varje version, men driftsättningshandboken bör beskriva dem.
Töm den gamla låskön. Versioner före 7.6.14 lämnade kvar en .build.lock-fil för varje innehållsändring. Efter uppgraderingen tar WP-Cron bort dem i begränsade omgångar. Kontrollera och töm hela kön på en gång så här:
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 lämnar lås som är nyare än en timme eller fortfarande innehas av en pågående förfrågan till nästa körning. Ta aldrig bort låsfiler manuellt medan webbplatsen hanterar trafik.
Rensa runtimecachen. wp bs cache clear rensar allt för den aktuella webbplatsen, och wp bs cache clear --scope=runtime rensar ett omfång i alla namnrymder. Nästa förfrågan bygger upp cachen från grunden, så kör kommandot när trafiken är låg och bara om du har anledning: ändringar i indata skapar redan nya nycklar.
Ta bort Blockstudio. En installation av typen Composer har ingen hook för avaktivering av tillägg, så inga cron-händelser avregistreras och inget drop-in för tidig leverans tas bort när paketet försvinner. Kör detta innan beroendet tas bort:
wp bs teardown
Det tar bort cron-händelserna och tillståndet för statisk förhandsrendering som installationen hanterar, lämnar främmande drop-in-filer och konfigurationsfiler orörda och gör att en senare återaktivering kan börja från ett rent läge.
Nästa steg
- Bygga filbaserade sidor: sidorna som den här driftsättningen synkroniserar.
- Sidreferens: synkbeteende, PHP-synkroniseringenAPI och avtalet för driftsättningsidentitet.
- CLIreferens: alla
wp bs-kommandon. - Cachelagring: cacheplats, identitet, lagringstid och låskön.
- Leverera WordPress som statisk HTML: cachen som steg 4 uppdaterar.
- Composer: installationer som tillägg, must-use, tema och paketbuntat tillägg.