Přejít k obsahu

Nasazení webu Blockstudio

U bloků stačí zkopírovat složku šablony na server: Blockstudio je objeví v souborovém systému a změněné vstupy automaticky zaznamená do mezipaměti. Skutečný web má více součástí. Stránky uložené v souborech se dostanou do databáze až po synchronizaci. Statické předgenerované stránky se dál zobrazují ve včerejší podobě HTML, dokud ji něco nenahradí. A vrstva CDN před webem nadále poskytuje obsah ze své mezipaměti.

Tento průvodce připraví nasazení šablony s názvem acme, která sdružuje Blockstudio prostřednictvím Composer. Popisuje, co se spouští v CI a co na serveru po nahrání souborů, jak číst protokol synchronizace stránek a které příkazy wp bs patří do vydání.

Vydání v jednom obrázku

  1. Sestavení. CI nainstaluje produkční závislosti Composer.
  2. Nahrání. Motiv včetně vendor/ se nahraje na server.
  3. Synchronizace stránek. wp bs pages sync uvede příspěvky stránek do souladu se soubory a vypíše zprávu.
  4. Obnovení mezipaměti zdroje. Uložená HTML se při změně stránek vymaže a poté znovu zahřeje.
  5. Vyprázdnění CDN. Nakonec, aby se okrajová mezipaměť naplnila z čerstvého zdroje.

Kroky 3 a 4 vyžadují na serveru WP-CLI. Níže uvedený skript také používá jq ke čtení JSON.

Krok 1: Composer v CI

Přibalte Blockstudio do motivu a potvrďte composer.lock, aby CI nainstalovalo přesně tu verzi, kterou jste otestovali:

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

V CI instalujte bez vývojových balíčků:

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

Blockstudio se inicializuje z autoloaderu a jeho vlastní běhové závislosti jsou přibalené a opatřené jmenným prostorem uvnitř balíčku. Při načtení z adresáře vendor/ je vestavěný aktualizátor GitHub vypnutý, takže jediným způsobem změny verze zůstává Composer.

Krok 2: Rozhodněte, do čeho je třeba zapisovat

Blockstudio za běhu zapisuje generované soubory. Než nasazení adresář nahradí nebo uzamkne, zjistěte, kam se zapisuje:

  • Běhové mezipaměti se ve výchozím nastavení nacházejí v wp-content/blockstudio/cache/. Pokud chcete, nasměrujte cache.path na vyhrazený zapisovatelný svazek. Změnou cesty se mezipaměť vyprázdní.
  • Zkompilované prostředky bloků se ve výchozím nastavení zapisují do složky _dist vedle každého bloku. Pokud je adresář vydání jen pro čtení nebo se při každém nasazení nahrazuje, nastavte assets.output na cache, aby se ukládaly do adresáře mezipaměti:
JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "assets": {
    "output": "cache"
  }
}

Při nasazení není třeba mazat mezipaměti. Každá položka mezipaměti je klíčována podle svých vstupů, včetně souborů bloků, nastavení, aktivního motivu a pluginů a verzí WordPress, PHP a Blockstudio, takže vydání, které je změní, získá nové klíče. V režimech production a staging důvěřuje Blockstudio ověřenému snímku sledování po dobu 20 sekund, než znovu zkontroluje soubory, takže zaznamenání změny může trvat až 20 sekund. Toto okno mění filtr blockstudio/cache/watch_debounce.

Krok 3: Synchronizace stránek

Příspěvky stránek se mění pouze při výslovné synchronizaci. Požadavky na frontend, administraci, Ajax, REST, cron ani běžné požadavky WP-CLI nikdy nevyhledávají zdroje stránek ani nezapisují příspěvky stránek. Nasazení musí spustit:

Shell
wp bs pages sync --format=json

Na webu, jehož motiv obsahuje dvě stránky, about a contact, je vytvoří první spuštění:

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

Jak zprávu číst:

  • created, updated, unchanged, removed a failed udávají počty stránek. Pokud se otisk zdroje stránky nezměnil, nevytvoří se žádný příspěvek ani metadata příspěvku a nespustí se žádné aktualizační hooky.
  • Každý průchod porovná úplný seznam stránek. fullReconciliation udává, zda se průchod počítá jako úplná synchronizace: true při prvním spuštění, při --full nebo při změně samotného synchronizačního modulu a false, pokud existuje identita z předchozí úspěšné synchronizace. Navazující nástroje podle toho mohou rozhodnout, zda vše znovu sestavit.
  • sourceIdentity je deterministický otisk seznamu stránek a synchronizačního modulu. Příkaz ho uloží po úspěšném průchodu.

Bez --format=json příkaz vypíše jeden souhrnný řádek a oznámení o úspěchu. V protokolu CI, který není terminálem, jsou hodnoty v řádku oddělené tabulátory:

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

Toto spuštění následovalo po úpravě about/index.php: jedna stránka byla aktualizována a jedna zůstala beze změny.

Když se synchronizace nezdaří

Pokud vyhledávání nebo synchronizace nahlásí chybu, příkaz skončí se stavovým kódem 1 a krok CI selže. Zpráva JSON se přesto vypíše, proto ji zaznamenejte. Chybně formátované page.json vypadá 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, jejichž zdrojové soubory zmizely, se odstraní až po dokončení průchodu bez chyb, takže vydání, jehož synchronizace selže, nesmaže aktivní stránky. Odstraněné stránky se ve výchozím nastavení přesunou do koše; filtr blockstudio/pages/orphan_action může vrátit trash, delete nebo keep.

Spouštějte při každém nasazení

Synchronizaci spouštějte, i když se žádná stránka nezměnila. Pokud nasazujete do adresářů jednotlivých vydání a přepínáte symbolický odkaz, odkazuje nezměněná stránka na cesty k šablonám a rozvržení předchozího vydání, dokud je neaktualizuje další synchronizace. Tato aktualizace nemění post_content ani datum změny.

--authoritative a --full

Běžná synchronizace zachovává obsah, který redaktoři změnili uvnitř bloků s klíči. --authoritative místo toho nahradí spravovaný obsah obsahem ze souborů a může zrušit zámek synchronizace stránky. Použijte jej, když mají mít přednost soubory: při resetování testovacího webu nebo na webu, kde nikdo neupravuje stránky navázané na soubory v editoru. Na webu s aktivními redaktory jej nespouštějte při každém nasazení.

--full označí průchod jako úplnou synchronizaci bez ohledu na uloženou identitu. Porovnání stránek je úplné při každém průchodu, takže příznak mění hodnotu fullReconciliation ve zprávě, nikoli stránky, které se kontrolují. Předejte jej, pokud se pozdější krok řídí touto hodnotou při úplném sestavení.

Nástroje napsané v PHP mohou přímo volat Blockstudio\Pages::reconcile(). Vrací stejnou zprávu, ale neukládá identitu: zavolejte Blockstudio\Pages::store_successful_source_identity(), až ověříte zbytek vydání, například aktivovaný statický výstup.

Krok 4: Obnovení statické mezipaměti

Pokud web používá statické předgenerování ve výchozím režimu signature, příspěvky stránek aktualizované z WP-CLI samy nevymažou uloženou HTML. Přečtěte zprávu, při jakékoli změně mezipaměť vymažte a poté ji zahřejte:

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é spuštění wp bs prerender warm zařadí zastaralé veřejné adresy URL do fronty, vykreslí až warm.concurrency z nich a vypíše souhrn. V tomto průchodu byly převzaty čtyři ze šesti adres URL ve frontě a vykreslení všech čtyř selhalo:

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

Adresa URL, jejíž vykreslení selže, zůstane zastaralá a při dalším spuštění se znovu zařadí do fronty. Proto se smyčka zastaví při prvním průchodu, který nic nezahřeje, místo aby čekala na prázdnou frontu. Zbývající adresy zpracuje plánovač zahřívání nebo další anonymní návštěva.

V režimu graph je zahřívání pro jednotlivé URL vypnuté a warm nic nezařazuje do fronty. Grafové weby nahrazují kroky 2 a 3 vlastním sestavením, které vykreslí dotčené adresy URL a výsledek aktivuje atomicky. Viz režimy podpisu a grafu.

Krok 5: Pracovní postup CI

Níže uvedený pracovní postup je příkladem pro GitHub Actions. Stejný postup lze použít v jakémkoli systému CI: sestavit, nahrát, spustit skript na serveru a vyprázdnit 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 zařadí druhé nasazení za právě probíhající nasazení místo toho, aby ho uprostřed synchronizace zrušilo. PHP 8.2 je minimální verze pro Blockstudio. V posledním kroku nahraďte CDN purge příkazem API.

Příkazy pro údržbu

Tyto příkazy nepatří do každého vydání, ale postup pro nasazení by je měl znát.

Vyprázdnění staré fronty zámků. Vydání před 7.6.14 zanechávala při každé změně obsahu soubor .build.lock. Po aktualizaci je WP-Cron odstraní v omezených dávkách. Kontrola a jednorázové vyprázdnění fronty:

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 mladší než hodinu nebo stále držené běžícím požadavkem do dalšího průchodu. Nikdy nemažte soubory zámků ručně, když web obsluhuje provoz.

Vymazání běhové mezipaměti. wp bs cache clear vymaže vše pro aktuální web a wp bs cache clear --scope=runtime vymaže jeden rozsah napříč všemi jmennými prostory. Další požadavek začne s prázdnou mezipamětí, proto příkaz spouštějte při nízkém provozu a jen tehdy, máte-li k tomu důvod: změny vstupů už klíče obměňují.

Odstranění Blockstudio. Instalace Composer nemá hook pro deaktivaci pluginu, takže po zmizení balíčku nic neodplánuje události cron ani neodstraní doplněk pro přednostní obsluhu. Před odstraněním závislosti spusťte:

Shell
wp bs teardown

Odstraní události cron a stav statického předgenerování, které tato instalace vlastní, ponechá cizí doplňky a konfigurační soubory nedotčené a umožní čisté opětovné zapnutí.

Další kroky