Liigu sisu juurde

Blockstudio saidi juurutamine

Teemakausta serverisse kopeerimisest piisab plokkide jaoks: Blockstudio avastab need failisüsteemist ja selle vahemälud märkavad sisendi muutusi automaatselt. Päris saidil on rohkem liikuvaid osi. Failipõhised lehed jõuavad andmebaasi ainult sünkroonimisel. Staatiline eeltöötlus jätkab eilse HTML kuvamist, kuni miski selle asendab. Selle ees olev CDN jätkab kõige selle näitamist, mis ta vahemällu salvestas.

See juhend koostab juurutuse teemale nimega acme, mis koondab Blockstudio läbi Composer. See käsitleb, mis käivitatakse CI-s, mis käivitatakse serveris pärast failide saabumist, kuidas lugeda lehtede sünkroonimisaruannet ja millised wp bs käsud kuuluvad väljalaskesse.

Väljalase ühel pildil

  1. Koosta. CI paigaldab tootmiskeskkonna Composer sõltuvused.
  2. Laadi üles. Teema, sealhulgas vendor/, jõuab serverisse.
  3. Sünkrooni lehed. wp bs pages sync viib lehepostitused failidega kooskõlla ja väljastab aruande.
  4. Värskenda lähtepoole vahemälu. Salvestatud HTML tühjendatakse, kui lehed muutusid, ning seejärel soojendatakse uuesti.
  5. Tühjenda CDN. Viimasena, et serv saaks andmed värskest lähteallikast.

Sammud 3 ja 4 vajavad serveris WP-CLI. Allolev skript kasutab lugemiseks ka jq väärtust JSON.

1. samm: Composer CI-s

Paki Blockstudio teemasse ja lisa versioonihaldusse composer.lock, et CI paigaldaks täpselt selle versiooni, mida testisid:

JSON
{
  "require": {
    "blockstudio/blockstudio": "^7.0"
  }
}
PHP
<?php
require_once __DIR__ . '/vendor/autoload.php';

Paigalda CI-s ilma arenduspakettideta:

Shell
composer install --no-dev --optimize-autoloader --no-interaction --prefer-dist

Blockstudio käivitub automaatlaaduri kaudu ning selle käitusaja sõltuvused on paketi sees ja nimeruumiga eraldatud. Kui see laaditakse kataloogist vendor/, on sisseehitatud GitHub uuendaja keelatud, nii et versiooni muutmiseks jääb ainsaks võimaluseks Composer.

2. samm: otsustage, mis peab olema kirjutatav

Blockstudio kirjutab käitusajal genereeritud faile. Enne kui juurutus kataloogi asendab või lukustab, tehke kindlaks, kuhu need kirjutatakse:

  • Käitusaegsed vahemälud asuvad vaikimisi asukohas wp-content/blockstudio/cache/. Soovi korral suunake cache.path spetsiaalsele kirjutatavale köitele. Tee muutmine alustab tühja vahemäluga.
  • Kompileeritud plokivarad kirjutatakse vaikimisi iga ploki kõrvale kataloogi _dist. Kui väljalaskekataloog on kirjutuskaitstud või asendatakse iga juurutusega, määrake assets.output väärtuseks cache, et need kirjutataks hoopis vahemälukataloogi:
JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "assets": {
    "output": "cache"
  }
}

Juurutamisel pole vaja vahemälu tühjendada. Iga vahemälukirje võti põhineb sisenditel, sealhulgas plokifailidel, seadistustel, aktiivsel teemal ja pluginatel ning versioonidel WordPress, PHP ja Blockstudio. Seega saab neid muutev väljalase uued võtmed. Režiimides production ja staging usaldab Blockstudio valideeritud jälgimishetktõmmist 20 sekundit, enne kui kontrollib faile uuesti; seetõttu võib muudatuse märkamiseks kuluda kuni 20 sekundit. Seda ajavahemikku muudab filter blockstudio/cache/watch_debounce.

3. samm: sünkrooni lehed

Lehepostitused muutuvad ainult selgesõnalise sünkroonimise kaudu. Frontendi, administraatori, Ajaxi, REST ja cron ning tavalised WP-CLI päringud ei tuvasta leheallikaid ega kirjuta lehepostitusi. Juurutus peab selleks käsu käivitama:

Shell
wp bs pages sync --format=json

Saidil, mille teemas on kaks lehte, about ja contact, loob esimene käivitus need:

JSON
{
    "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": []
}

Tulemuse lugemine:

  • created, updated, unchanged, removed ja failed näitavad lehtede arvu. Kui lehe allika sõrmejälg pole muutunud, siis postitust ega postituse metaandmeid ei kirjutata ja uuendamise konkse ei käivitata.
  • Igal käivitusel võrreldakse kogu lehtede loendit. fullReconciliation näitab, kas käivitus loetakse täielikuks sünkroonimiseks: true esimesel käivitusel, kui kasutatakse --full või kui sünkroonimismootor ise muutus, ning false siis, kui varasemast edukast sünkroonimisest on olemas tunnus. Allavoolu tööriistad saavad selle põhjal otsustada, kas kõik tuleb uuesti koostada.
  • sourceIdentity on lehtede loendi ja sünkroonimismootori deterministlik sõrmejälg. Käsk salvestab selle pärast edukat käivitust.

Ilma --format=json-ta väljastab käsk ühe kokkuvõtterea ja eduteate. CI logis, mis pole terminal, eraldatakse rea väärtused tabeldusmärkidega:

Text
discovered	created	updated	unchanged	removed	failed	source_id
2	0	1	1	0	0	7bd575b4ee6c0a948f439dd83ce5fa403f8113c9406c3b13b6ade2f2b19f3c2c
Success: File-backed pages synchronized.

See käivitus järgnes faili about/index.php muutmisele: üks leht uuendati, teine jäi muutumatuks.

Kui sünkroonimine ebaõnnestub

Käsk väljub olekuga 1, kui avastamisel või sünkroonimisel tekib viga, mistõttu CI samm ebaõnnestub. Aruanne JSON väljastatakse siiski, seega lisage see logisse. Vigane page.json näeb välja nii:

JSON
{
    "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"
            }
        }
    ]
}

Hallatavad lehed, mille allikad on kadunud, eemaldatakse alles pärast veatult lõppenud käivitust, nii et sünkroonimise ebaõnnestumine väljalaskel ei kustuta aktiivseid lehti. Vaikimisi teisaldatakse eemaldatud lehed prügikasti; filter blockstudio/pages/orphan_action võib tagastada trash, delete või keep.

Käivitage see iga juurutusega

Käivitage sünkroonimine ka siis, kui ükski leht pole muutunud. Kui juurutate väljalaskekataloogidesse ja vahetate sümbollingi, viitavad muutmata lehed endiselt eelmise väljalaske mallidele ja paigutusteedele, kuni järgmine sünkroonimine need värskendab. Värskendamisel ei muudeta post_content ega muutmiskuupäeva.

--authoritative ja --full

Tavaline sünkroonimine säilitab sisu, mida toimetajad on võtmega plokkides muutnud. --authoritative asendab hallatava sisu failidest pärit sisuga ja võib eemaldada lehe sünkroonimise lukustuse. Kasutage seda siis, kui failide sisu peab jääma peale: näiteks testkeskkonna lähtestamisel või saidil, kus keegi failipõhiseid lehti redaktoris ei muuda. Ärge kasutage seda iga juurutuse ajal saidil, millel on aktiivsed toimetajad.

--full märgib käivituse täielikuks sünkroonimiseks, olenemata salvestatud tunnusest. Lehti võrreldakse täielikult juba igal käivitusel, nii et see lipp muudab aruandes väärtust fullReconciliation, mitte kontrollitavaid lehti. Kasutage seda siis, kui hilisem samm käivitab selle väärtuse põhjal täieliku ümberehituse.

PHP-is kirjutatud tööriistad saavad otse kutsuda funktsiooni Blockstudio\Pages::reconcile(). See tagastab sama aruande, kuid ei salvesta tunnust: kutsuge välja Blockstudio\Pages::store_successful_source_identity() pärast seda, kui väljalaske ülejäänud osad, näiteks aktiveeritud staatiline artefakt, on kontrollitud.

4. samm: värskenda staatilist vahemälu

Kui sait kasutab vaikerežiimis signature staatilist eeltöötlust], ei tühjenda WP-CLI põhjal uuendatud lehepostitused salvestatud HTML ise. Lugege aruannet ja tühjendage vahemälu, kui midagi muutus, seejärel soojendage see:

Shell
#!/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}'

Iga wp bs prerender warm käivitus lisab aegunud avalikud URL-id järjekorda, renderdab neist kuni warm.concurrency ja väljastab kokkuvõtte. Selles käivituses võeti järjekorrast kuuest URL-ist neli, kuid kõigi nelja renderdamine ebaõnnestus:

JSON
{"queued":6,"processed":4,"warmed":0,"skipped":0,"failed":4}

Renderdamisel ebaõnnestunud URL jääb aegunuks ja lisatakse järgmisel käivitusel uuesti järjekorda. Seetõttu peatub tsükkel esimesel käivitusel, mis midagi ei soojenda, ega oota järjekorra tühjenemist. Ülejäänu töötleb ajastatud soojendaja või järgmine anonüümne külastus.

Režiimis graph on iga URL soojendaja välja lülitatud ja warm ei lisa järjekorda midagi. Graafisaidid asendavad sammud 2 ja 3 oma koostega, mis renderdab mõjutatud URL-id ja aktiveerib tulemuse aatomiliselt. Vt allkirja- ja graafirežiimid.

5. samm: CI töövoog

Allolev töövoog on GitHub Actions näide. Sama ülesehitus sobib iga CI-süsteemiga: koosta, laadi üles, käivita skript serveris ja tühjenda CDN.

YAML
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 koos cancel-in-progress: false-ga paneb teise käivituse järjekorras töötava juurutuse taha, selle asemel et see sünkroonimise keskel tühistada. PHP 8.2 on Blockstudio miinimumversioon. Asendage viimane samm oma CDN tühjendamise API-ga.

Hoolduskäsud

Neid ei kuulu igasse väljalaskesse lisada, kuid juurutusjuhend peaks neid käsitlema.

Pärandlukustuste järjekorra tühjendamine. Enne versiooni 7.6.14 jättis iga sisumuudatus maha faili .build.lock. Pärast uuendamist eemaldab WP-Cron need piiratud partiidena. Kontrollimiseks ja kogu järjekorra korraga tühjendamiseks:

Shell
wp bs cache status
wp bs cache cleanup
Text
0 legacy build lock(s) across 0 cache namespace(s).
Next cleanup batch in 0 second(s).

cleanup jätab järgmise käivituseni alles lukud, mis on alla tunni vanad või mida hoiab endiselt käimasolev päring. Ärge kunagi kustutage lukufaile käsitsi, kui sait teenindab liiklust.

Käitusaegse vahemälu tühjendamine. wp bs cache clear tühjendab kõik praeguse saidi andmed, wp bs cache clear --scope=runtime aga tühjendab ühe ulatuse kõigis nimeruumides. Järgmine päring ehitab tühja vahemälu uuesti üles, seega käivitage see vähese liiklusega ajal ja ainult põhjendatud vajadusel: sisendi muutmine vahetab võtmed niigi.

Blockstudio eemaldamine. Composer paigaldusel puudub plugina desaktiveerimise konks, mistõttu paketi kadumisel ei tühistata cron sündmusi ega eemaldata varase teenindamise lisakomponenti. Käivitage see enne sõltuvuse eemaldamist:

Shell
wp bs teardown

See eemaldab sündmused cron ja sellele paigaldusele kuuluva staatilise eeltöötluse oleku, jätab teiste lisakomponendid ja konfiguratsioonifailid puutumata ning võimaldab hiljem puhtalt uuesti aktiveerida.

Järgmised sammud