Preskočiť na obsah

Nasadenie stránky Blockstudio

Pri blokoch stačí skopírovať priečinok témy na server: Blockstudio ich vyhľadá v súborovom systéme a jeho vyrovnávacie pamäte samy rozpoznajú zmenené vstupy. Skutočná stránka má viac pohyblivých častí. Stránky založené na súboroch sa dostanú do databázy až po synchronizácii. Statické predbežné vykreslenie naďalej zobrazuje včerajšie HTML, kým ho niečo nenahradí. CDN pred stránkou naďalej zobrazuje obsah svojej vyrovnávacej pamäte.

Táto príručka opisuje nasadenie témy s názvom acme, ktorá spája Blockstudio prostredníctvom Composer. Vysvetľuje, čo sa spúšťa v CI, čo sa spúšťa na serveri po nahratí súborov, ako čítať hlásenie o synchronizácii stránok a ktoré príkazy wp bs patria do vydania.

Vydanie na jednom obrázku

  1. Zostavenie. CI nainštaluje produkčné závislosti Composer.
  2. Nahratie. Téma vrátane vendor/ sa dostane na server.
  3. Synchronizácia stránok. wp bs pages sync zosúladí príspevky stránok so súbormi a vypíše správu.
  4. Obnovenie vyrovnávacej pamäte zdroja. Uložená HTML sa pri zmene stránok vymaže a potom sa znova naplní.
  5. Vymazanie CDN. Ako posledný krok, aby sa okrajová vyrovnávacia pamäť znovu naplnila z aktuálneho zdroja.

Kroky 3 a 4 vyžadujú WP-CLI na serveri. Nižšie uvedený skript používa aj jq na čítanie JSON.

Krok 1: Composer v CI

Zabaľte Blockstudio do témy a potvrďte composer.lock, aby CI nainštalovalo presne tú verziu, ktorú ste otestovali:

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

V CI nainštalujte balík bez vývojových závislostí:

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

Blockstudio sa spúšťa cez autoloader a jeho vlastné runtime závislosti sú pribalené a namespacované v balíku. Keď sa načíta z adresára vendor/, jeho vstavaný aktualizátor GitHub je vypnutý, takže jediným spôsobom zmeny verzie zostáva Composer.

Krok 2: Určite, čo musí byť zapisovateľné

Blockstudio vytvára za behu generované súbory. Ešte pred nasadením, ktoré nahradí alebo uzamkne adresár, zistite kde:

  • Runtime vyrovnávacie pamäte sa predvolene nachádzajú v wp-content/blockstudio/cache/. Ak chcete, nasmerujte cache.path na samostatný zapisovateľný zväzok. Zmena cesty znamená prázdnu vyrovnávaciu pamäť.
  • Kompilované zdroje blokov sa predvolene zapisujú do priečinka _dist vedľa každého bloku. Ak je adresár vydania iba na čítanie alebo sa pri každom nasadení nahrádza, nastavte assets.output na cache, aby sa súbory namiesto toho ukladali do adresára vyrovnávacej pamäte:
JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "assets": {
    "output": "cache"
  }
}

Pri nasadení nemusíte vymazávať vyrovnávacie pamäte. Každá položka je označená kľúčmi odvodenými od vstupov vrátane súborov blokov, nastavení, aktívnej témy a pluginov a verzií WordPress, PHP a Blockstudio, takže vydanie, ktoré ich zmení, dostane nové kľúče. V prostrediach production a staging dôveruje Blockstudio overenému snímku sledovania 20 sekúnd, než znova skontroluje súbory. Zmena sa preto môže prejaviť až po 20 sekundách. Tento interval mení filter blockstudio/cache/watch_debounce.

Krok 3: Synchronizácia stránok

Príspevky stránok sa menia iba pri výslovnej synchronizácii. Požiadavky z frontendu, administrácie, Ajaxu, REST, cron ani bežné požiadavky WP-CLI nikdy nevyhľadávajú zdroje stránok ani nezapisujú príspevky stránok. Nasadenie musí spustiť:

Shell
wp bs pages sync --format=json

Na webe, ktorého téma obsahuje dve stránky, about a contact, ich prvé spustenie vytvorí:

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

Ako čítať výpis:

  • created, updated, unchanged, removed a failed predstavujú počty stránok. Ak sa odtlačok zdroja stránky nezmenil, nevytvorí sa ani neupraví žiadny príspevok či metadáta a nespustia sa žiadne hooky aktualizácie.
  • Pri každom prechode sa porovnáva celý súpis stránok. fullReconciliation uvádza, či sa prechod považuje za úplnú synchronizáciu: true pri prvom spustení, pri --full alebo pri zmene samotného synchronizačného nástroja a false, ak existuje identita z predchádzajúcej úspešnej synchronizácie. Následné nástroje podľa toho môžu rozhodnúť, či majú všetko znova zostaviť.
  • sourceIdentity je deterministický odtlačok súpisu stránok a synchronizačného nástroja. Príkaz ho uloží po úspešnom prechode.

Bez --format=json príkaz vypíše jeden súhrnný riadok a správu o úspechu. V zázname CI, ktorý nie je terminálom, sú hodnoty oddelené tabulátormi:

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

Toto spustenie nasledovalo po úprave about/index.php: jedna stránka sa aktualizovala a druhá zostala nezmenená.

Keď synchronizácia zlyhá

Ak vyhľadávanie alebo synchronizácia oznámi chybu, príkaz skončí so stavom 1 a krok CI zlyhá. Správa JSON sa napriek tomu vypíše, preto ju zaznamenajte. Chybný page.json vyzerá takto:

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

Spravované stránky, ktorých zdroje zmizli, sa odstránia až po dokončení prechodu bez chýb, takže nasadenie, pri ktorom synchronizácia zlyhá, nevymaže živé stránky. Odstránené stránky sa predvolene presunú do koša; filter blockstudio/pages/orphan_action môže vrátiť trash, delete alebo keep.

Spúšťajte pri každom nasadení

Spustite synchronizáciu, aj keď sa nezmenila žiadna stránka. Ak nasadzujete do adresárov vydaní a prepínate symbolický odkaz, nezmenená stránka stále odkazuje na cesty k šablónam a rozloženiam predchádzajúceho vydania, kým ich neobnoví ďalšia synchronizácia. Obnovenie nemení post_content ani dátum úpravy.

--authoritative a --full

Bežná synchronizácia zachová obsah, ktorý redaktori upravili v pomenovaných blokoch. --authoritative namiesto toho nahradí spravovaný obsah súbormi a môže zrušiť zámok Page Sync. Použite ju, keď majú rozhodovať súbory: pri resetovaní prípravného webu alebo webu, kde nikto neupravuje stránky založené na súboroch v editore. Na webe s aktívnymi redaktormi ju nespúšťajte pri každom nasadení.

--full označí prechod ako úplnú synchronizáciu bez ohľadu na uloženú identitu. Porovnanie stránok je už pri každom prechode úplné, takže príznak mení v správe hodnotu fullReconciliation, nie stránky, ktoré sa kontrolujú. Použite ho, ak neskorší krok podľa tejto hodnoty spúšťa úplné opätovné zostavenie.

Nástroje napísané v PHP môžu priamo zavolať Blockstudio\Pages::reconcile(). Vráti rovnakú správu, ale neuloží identitu: zavolajte Blockstudio\Pages::store_successful_source_identity() po overení zvyšku vydania, napríklad aktivovaného statického artefaktu.

Krok 4: Obnovenie statickej vyrovnávacej pamäte

Ak web používa predvykresľovanie do statického formátu v predvolenom režime signature, aktualizované príspevky stránok z WP-CLI samy nevymažú uloženú HTML. Prečítajte správu, pri každej zmene ju vymažte a potom vyrovnávaciu pamäť naplňte:

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}'

Každé spustenie wp bs prerender warm zaradí zastarané verejné adresy URL do frontu, vykreslí až warm.concurrency z nich a vypíše súhrn. V tomto prechode sa spracovali štyri zo šiestich adries URL vo fronte a všetky štyri vykreslenia zlyhali:

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

URL, ktorého vykreslenie zlyhá, zostane zastarané a pri ďalšom spustení sa znova zaradí do frontu. Preto sa cyklus zastaví pri prvom prechode, ktorý nič nenaplní, namiesto čakania na prázdny front. Zvyšné položky spracuje plánovač alebo ďalšia anonymná návšteva.

V režime graph je predvykresľovanie pre každé URL vypnuté a warm nič nezaraďuje do frontu. Weby s grafovým režimom nahrádzajú kroky 2 a 3 vlastným zostavením, ktoré vykreslí dotknuté adresy URL a výsledok aktivuje naraz. Pozrite si podpisové a grafové režimy.

Krok 5: Pracovný postup CI

Nižšie uvedený pracovný postup je príklad GitHub Actions. Jeho štruktúru môžete použiť v ľubovoľnom systéme CI: zostaviť, nahrať, spustiť skript na serveri a vymazať 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 s cancel-in-progress: false zaradí druhé nasadenie za práve prebiehajúce namiesto toho, aby ho zrušil uprostred synchronizácie. PHP 8.2 je minimálna verzia pre Blockstudio. Posledný krok nahraďte vymazaním API pre CDN.

Príkazy údržby

Tieto príkazy nepatria do každého vydania, no postup nasadenia by s nimi mal počítať.

Vyprázdnenie starého radu zámkov. Vydania spred 7.6.14 zanechávali po každej zmene obsahu súbor .build.lock. Po aktualizácii ich WP-Cron odstraňuje v dávkach s obmedzenou veľkosťou. Kontrola aj vyprázdnenie celého radu:

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 ponechá zámky novšie ako hodinu alebo tie, ktoré stále drží prebiehajúca požiadavka, až do ďalšieho prechodu. Nikdy nemažte súbory zámkov ručne, kým web obsluhuje návštevnosť.

Vymazanie runtime vyrovnávacej pamäte. wp bs cache clear vymaže všetko pre aktuálny web a wp bs cache clear --scope=runtime vymaže jeden rozsah vo všetkých menných priestoroch. Ďalšia požiadavka začne s prázdnou pamäťou, preto príkaz spúšťajte pri nízkej návštevnosti a iba v odôvodnených prípadoch: zmeny vstupov už kľúče obmieňajú.

Odstránenie Blockstudio. Inštalácia Composer nemá hook na deaktiváciu pluginu, takže po odstránení balíka sa nezrušia naplánované udalosti cron ani neodstráni doplnkový súbor na skoré zobrazovanie. Spustite tento príkaz pred odstránením závislosti:

Shell
wp bs teardown

Odstráni udalosti cron a stav statického predvykresľovania, ktoré patria tejto inštalácii, ponechá cudzie doplnkové súbory a konfiguračné súbory nedotknuté a umožní čisté opätovné zapnutie.

Ďalšie kroky