Pereiti prie turinio

Blockstudio svetainės diegimas

Blokams įdiegti pakanka nukopijuoti temos aplanką į serverį: Blockstudio aptinka juos failų sistemoje, o jo talpyklos pačios pastebi pasikeitusius duomenis. Tikroje svetainėje yra daugiau komponentų. Failais pagrįsti puslapiai duomenų bazę pasiekia tik juos sinchronizavus. Statinis iš anksto atvaizduotas puslapis toliau pateikia vakarykštį HTML, kol kas nors jo nepakeičia. Priekyje esantis CDN toliau pateikia savo išsaugotą versiją.

Šiame vadove parodysime, kaip sukurti temos, pavadintos acme, diegimo procesą. Joje per Composer sujungiama Blockstudio. Aptarsime, kas vykdoma CI aplinkoje, kas serveryje, kai failai jau perkelti, kaip skaityti puslapių sinchronizavimo ataskaitą ir kurias wp bs komandas įtraukti į leidimą.

Leidimas viename paveiksle

  1. Sukūrimas. CI įdiegia gamybinės aplinkos Composer priklausomybes.
  2. Įkėlimas. Tema, įskaitant vendor/, pasiekia serverį.
  3. Puslapių sinchronizavimas. wp bs pages sync suderina puslapių įrašus su failais ir pateikia ataskaitą.
  4. Kilmės serverio podėlio atnaujinimas. Išsaugotas HTML išvalomas, jei puslapiai pasikeitė, tada užpildomas iš naujo.
  5. CDN išvalymas. Galiausiai, kad pakraščio podėlis būtų užpildytas iš naujo kilmės serverio.

3 ir 4 veiksmams serveryje reikia WP-CLI. Toliau pateiktas scenarijus taip pat naudoja jq, kad nuskaitytų JSON.

1 veiksmas: Composer CI aplinkoje

Įtraukite Blockstudio į temos paketą ir įrašykite composer.lock, kad CI įdiegtų tikslią jūsų išbandytą versiją:

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

CI aplinkoje įdiekite be kūrimo paketų:

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

Blockstudio paleidžiama iš automatinio įkėlimo failo, o jos vykdymo aplinkos priklausomybės yra įtrauktos į paketą ir turi savo vardų sritį. Kai ji įkeliama iš vendor/ katalogo, jos integruota GitHub naujintuvė išjungiama, todėl Composer lieka vieninteliu būdu pakeisti versiją.

2 veiksmas: nuspręskite, ką reikia įrašyti

Blockstudio vykdymo metu įrašo sugeneruotus failus. Prieš diegdami naują versiją, kuri pakeičia arba užrakina katalogą, išsiaiškinkite, kur jie įrašomi:

  • Vykdymo aplinkos podėliai pagal numatytuosius nustatymus saugomi po wp-content/blockstudio/cache/. Jei norite, nurodykite cache.path specialų įrašomą tomą. Pakeitus kelią, podėlis bus tuščias.
  • Kompiliuoti blokų ištekliai pagal numatytuosius nustatymus įrašomi į aplanką _dist šalia kiekvieno bloko. Jei leidimo katalogas yra tik skaitomas arba pakeičiamas kiekvieno diegimo metu, nustatykite assets.output į cache, kad jie būtų įrašomi į podėlio katalogą:
JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "assets": {
    "output": "cache"
  }
}

Diegiant nereikia išvalyti podėlių. Kiekvienas podėlio įrašas susiejamas su savo įvesties duomenimis, įskaitant blokų failus, nustatymus, aktyvią temą ir įskiepius bei WordPress, PHP ir Blockstudio versijas, todėl pakeitus juos leidime naudojami nauji raktai. production ir staging aplinkose Blockstudio 20 sekundžių pasikliauja patvirtinta stebėjimo momentine kopija ir tik tada vėl tikrina failus, todėl pakeitimo aptikimas gali užtrukti iki 20 sekundžių. blockstudio/cache/watch_debounce filtras keičia šį laikotarpį.

3 veiksmas: sinchronizuokite puslapius

Puslapių įrašai pakeičiami tik aiškiai paleidus sinchronizavimą. Frontend, administravimo, Ajax, REST, cron ir įprastos WP-CLI užklausos niekada neaptinka puslapių šaltinių ir neįrašo puslapių įrašų. Diegimo metu reikia paleisti:

Shell
wp bs pages sync --format=json

Svetainėje, kurios temoje yra du puslapiai – about ir contact, – pirmoji vykdymo užklausa juos sukuria:

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

Kaip tai suprasti:

  • created, updated, unchanged, removed ir failed nurodo puslapių skaičių. Jei puslapio šaltinio kontrolinė suma nepasikeitė, įrašas ir jo metaduomenys neįrašomi, o atnaujinimo kabliai neiškviečiami.
  • Kiekvieno vykdymo metu palyginamas visas puslapių sąrašas. fullReconciliation nurodo, ar vykdymas laikomas visišku sinchronizavimu: true pirmą kartą, naudojant --full arba pasikeitus pačiam sinchronizavimo varikliui, ir false, jei yra ankstesnio sėkmingo sinchronizavimo identifikatorius. Tolesni įrankiai gali pagal tai nuspręsti, ar reikia viską kurti iš naujo.
  • sourceIdentity yra deterministinė puslapių sąrašo ir sinchronizavimo variklio kontrolinė suma. Sėkmingai užbaigus vykdymą, komanda ją išsaugo.

Jei nenaudojamas --format=json, komanda išspausdina vieną suvestinės eilutę ir sėkmės pranešimą. CI žurnale, kuris nėra terminalas, eilutės reikšmės atskirtos tabuliacijos ženklais:

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

Šis vykdymas įvyko po about/index.php redagavimo: vienas puslapis atnaujintas, kitas nepasikeitė.

Kai sinchronizuoti nepavyksta

Jei aptikimo arba sinchronizavimo metu pranešama apie klaidą, komanda baigiama su 1 būsenos kodu ir CI veiksmas nepavyksta. Vis tiek išspausdinama JSON ataskaita, todėl įrašykite ją žurnale. Netinkamai suformuotas page.json atrodo taip:

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

Tvarkomi puslapiai, kurių šaltiniai dingo, pašalinami tik tada, kai sinchronizavimas baigiamas be klaidų, todėl nepavykus sinchronizuoti leidimo metu aktyvūs puslapiai neprarandami. Pagal numatytuosius nustatymus pašalinti puslapiai perkeliami į šiukšlinę; filtras blockstudio/pages/orphan_action gali grąžinti trash, delete arba keep.

Paleiskite per kiekvieną diegimą

Sinchronizuokite net jei nė vienas puslapis nepasikeitė. Jei diegiate į leidimų katalogus ir perjungiate simbolinę nuorodą, nepakeistas puslapis vis dar nurodo ankstesnio leidimo šablono ir išdėstymo kelius, kol kitas sinchronizavimas juos atnaujina. Šis atnaujinimas nekeičia post_content ar pakeitimo datos.

--authoritative ir --full

Įprastas sinchronizavimas išsaugo redaktorių pakeistą turinį raktu pažymėtuose blokuose. --authoritative pakeičia tvarkomą turinį failų turiniu ir gali panaikinti „Page Sync“ užraktą. Naudokite šią parinktį, kai pirmenybę teikiate failams: iš naujo nustatydami bandomąją svetainę arba svetainę, kurioje niekas neredaguoja failais pagrįstų puslapių redaktoriuje. Nenaudokite jos per kiekvieną diegimą svetainėje, kurioje aktyviai dirba redaktoriai.

--full pažymi vykdymą kaip visišką sinchronizavimą, nepaisant išsaugoto identifikatoriaus. Puslapiai ir taip palyginami kiekvieno vykdymo metu, todėl ši parinktis ataskaitoje pakeičia fullReconciliation, o ne tikrinamus puslapius. Nurodykite ją, kai vėlesnis veiksmas pagal šią reikšmę paleidžia visko atkūrimą.

PHP parašyti įrankiai gali tiesiogiai iškviesti Blockstudio\Pages::reconcile(). Ji grąžina tą pačią ataskaitą, tačiau neišsaugo identifikatoriaus: iškvieskite Blockstudio\Pages::store_successful_source_identity(), kai bus patikrinta likusi leidimo dalis, pavyzdžiui, aktyvuotas statinis artefaktas.

4 veiksmas: atnaujinkite statinį podėlį

Jei svetainėje naudojamas statinis išankstinis generavimas numatytuoju signature režimu, iš WP-CLI atnaujinti puslapių įrašai patys neišvalo išsaugoto HTML. Perskaitykite ataskaitą ir, jei kas nors pasikeitė, išvalykite podėlį, tada užpildykite jį iš anksto:

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

Kiekvieno wp bs prerender warm vykdymo metu į eilę įtraukiami pasenę viešieji URL, pateikiama iki warm.concurrency jų ir išspausdinama suvestinė. Šio vykdymo metu iš šešių eilėje esančių URL apdoroti keturi, tačiau pateikti nepavyko nė vieno:

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

Jei URL nepavyksta pateikti, jis lieka pasenęs ir per kitą vykdymą vėl įtraukiamas į eilę. Todėl ciklas baigiamas po pirmojo vykdymo, kurio metu niekas nebuvo atnaujinta, užuot laukus, kol eilė ištuštės. Likusius URL apdoros suplanuota podėlio užpildymo užduotis arba kitas anoniminis apsilankymas.

graph režimu atskirų URL podėlio užpildymas išjungtas, o warm nieko neįtraukia į eilę. Grafų svetainėse 2 ir 3 veiksmus pakeičia atskiras jų kūrimo procesas, kuris pateikia paveiktus URL ir atomiškai aktyvuoja rezultatą. Žr. parašo ir grafų režimai.

5 veiksmas: CI eiga

Toliau pateikta eiga yra GitHub Actions pavyzdys. Tokia pati struktūra tinka bet kuriai CI sistemai: sukurkite, įkelkite, paleiskite scenarijų serveryje ir išvalykite 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 su cancel-in-progress: false į eilę įtraukia antrą įkėlimą už vykdomo diegimo, užuot atšaukęs jį sinchronizavimo viduryje. PHP 8.2 yra minimali Blockstudio versija. Paskutinį veiksmą pakeiskite savo CDN podėlio išvalymo API.

Priežiūros komandos

Šių komandų nereikia naudoti per kiekvieną leidimą, tačiau jas turi žinoti diegimo instrukcijose dirbantys žmonės.

Senų užraktų eilės išvalymas. Ankstesniuose nei 7.6.14 leidimuose po kiekvieno turinio pakeitimo likdavo .build.lock failas. Atnaujinus WP-Cron juos pašalina riboto dydžio paketais. Norėdami patikrinti ir išvalyti visą eilę iš karto:

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 palieka senesnius nei valandos užraktus arba tuos, kuriuos vis dar naudoja vykdoma užklausa, kitam paleidimui. Niekada netrinkite užraktų failų rankiniu būdu, kol svetainė aptarnauja srautą.

Vykdymo aplinkos podėlio išvalymas. wp bs cache clear išvalo viską dabartinėje svetainėje, o wp bs cache clear --scope=runtime išvalo vieną sritį visose vardų srityse. Kita užklausa viską sukurs iš naujo, todėl vykdykite šią komandą esant mažam srautui ir tik tada, kai tam yra priežastis: pakeitus įvesties duomenis raktai ir taip pasikeičia.

Blockstudio pašalinimas. Composer diegime nėra įskiepio išjungimo kablio, todėl paketui dingus niekas neatšaukia suplanuotų cron įvykių ar nepašalina ankstyvo pateikimo papildinio. Paleiskite šią komandą prieš pašalindami priklausomybę:

Shell
wp bs teardown

Ji pašalina šiai instaliacijai priklausančius cron įvykius ir statinio išankstinio generavimo būseną, neliečia svetimų papildinių ar konfigūracijos failų ir leidžia švariai vėl įjungti funkciją.

Tolesni veiksmai