Siirry sisältöön

Blockstudio-sivuston käyttöönotto

Lohkoille riittää teemakansion kopiointi palvelimelle: Blockstudio löytää ne tiedostojärjestelmästä, ja sen välimuistit huomaavat muuttuneet syötteet automaattisesti. Oikeassa sivustossa on enemmän liikkuvia osia. Tiedostopohjaiset sivut päätyvät tietokantaan vasta synkronoinnin jälkeen. Staattinen esirenderöinti näyttää yhä eilisen HTML-version, kunnes jokin korvaa sen. Edessä oleva CDN näyttää edelleen kaiken, mitä se on tallentanut välimuistiin.

Tässä oppaassa rakennetaan käyttöönotto teeman acme ympärille. Teema kokoaa Blockstudio-sisältöä kohteen Composer kautta. Opas käsittelee CI:ssä suoritettavat toiminnot, tiedostojen saapumisen jälkeiset palvelintoiminnot, sivujen synkronointiraportin lukemisen sekä sen, mitkä wp bs-komennot kuuluvat julkaisuun.

Julkaisu yhdellä silmäyksellä

  1. Koonti. CI asentaa tuotannon Composer-riippuvuudet.
  2. Lataus. Teema, mukaan lukien vendor/, siirretään palvelimelle.
  3. Sivujen täsmäytys. wp bs pages sync synkronoi sivujulkaisut tiedostojen kanssa ja tulostaa raportin.
  4. Alkuperäpalvelimen välimuistin päivitys. Tallennettu HTML tyhjennetään, jos sivut muuttuivat, ja ladataan sitten uudelleen välimuistiin.
  5. CDN-välimuistin tyhjennys. Tee tämä viimeiseksi, jotta reunapalvelin täyttää välimuistinsa uudesta alkuperästä.

Vaiheet 3 ja 4 tarvitsevat palvelimella WP-CLI. Alla oleva skripti käyttää myös jq-komentoa tiedoston JSON lukemiseen.

Vaihe 1: Composer CI:ssä

Sisällytä Blockstudio teemaan ja tallenna composer.lock, jotta CI asentaa täsmälleen testaamasi version:

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

Asenna CI:ssä ilman kehityspaketteja:

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

Blockstudio käynnistyy automaattisen lataajan kautta, ja sen omat ajonaikaiset riippuvuudet on niputettu ja nimiavaruuksitettu paketin sisällä. Kun se ladataan vendor/-hakemistosta, sen sisäänrakennettu GitHub-päivitystoiminto poistetaan käytöstä, joten Composer jää ainoaksi tavaksi vaihtaa versiota.

Vaihe 2: Päätä, minkä on oltava kirjoitettavissa

Blockstudio kirjoittaa luotuja tiedostoja ajon aikana. Selvitä niiden sijainti ennen kuin käyttöönotto korvaa hakemiston tai lukitsee sen:

  • Ajonaikaiset välimuistit sijaitsevat oletusarvoisesti hakemiston wp-content/blockstudio/cache/ alla. Voit halutessasi määrittää cache.path-asetuksen osoittamaan erilliseen kirjoitettavissa olevaan taltioon. Polun muuttaminen aloittaa tyhjällä välimuistilla.
  • Käännetyt lohkoresurssit kirjoitetaan oletusarvoisesti kunkin lohkon viereiseen _dist-kansioon. Jos julkaisuja sisältävä hakemisto on vain luku -tilassa tai se korvataan jokaisessa käyttöönotossa, aseta assets.output arvoon cache, jotta tiedostot tallennetaan sen sijaan välimuistihakemistoon:
JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "assets": {
    "output": "cache"
  }
}

Välimuisteja ei tarvitse tyhjentää käyttöönoton yhteydessä. Jokaisen välimuistimerkinnän avaimet perustuvat sen syötteisiin, kuten lohkotiedostoihin, asetuksiin, aktiiviseen teemaan ja lisäosiin sekä versioihin WordPress, PHP ja Blockstudio, joten ne muuttava julkaisu saa uudet avaimet. Tilassa production ja staging Blockstudio luottaa vahvistettuun tarkkailutilanteen tilannekuvaan 20 sekunnin ajan ennen tiedostojen seuraavaa tarkistusta, joten muutoksen havaitsemiseen voi kulua enintään 20 sekuntia. blockstudio/cache/watch_debounce-suodattimella voit muuttaa tätä aikaväliä.

Vaihe 3: Sivujen täsmäytys

Sivujulkaisut muuttuvat vain nimenomaisen synkronoinnin kautta. Käyttöliittymän, hallintapaneelin, Ajaxin, RESTn, cronn ja tavalliset WP-CLI-pyynnöt eivät etsi sivulähteitä eivätkä kirjoita sivujulkaisuja. Käyttöönotossa on käynnistettävä täsmäytys:

Shell
wp bs pages sync --format=json

Sivustolla, jonka teemassa on kaksi sivua, about ja contact, ensimmäinen ajo luo ne:

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

Näin luet tulostetta:

  • created, updated, unchanged, removed ja failed laskevat sivuja. Jos sivun lähteen sormenjälki ei ole muuttunut, julkaisua tai julkaisun metatietoja ei kirjoiteta eikä päivityskoukkuja suoriteta.
  • Jokaisella ajokerralla verrataan kaikkia sivuja. fullReconciliation ilmoittaa, lasketaanko ajo täydelliseksi täsmäytykseksi: true ensimmäisellä ajokerralla, kun käytössä on --full tai synkronointimoottori on muuttunut, ja false, kun edellisen onnistuneen synkronoinnin tunniste on olemassa. Muut työkalut voivat käyttää tätä tietoa päättääkseen, pitääkö kaikki rakentaa uudelleen.
  • sourceIdentity on deterministinen sormenjälki sivuluettelosta ja synkronointimoottorista. Komento tallentaa sen onnistuneen ajon jälkeen.

Ilman --format=json-valitsinta komento tulostaa yhden yhteenvetorivin ja onnistumisviestin. CI-lokissa, joka ei ole pääte, rivi on sarkaineroteltu:

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

Ajo käynnistettiin tiedoston about/index.php muokkauksen jälkeen: yksi sivu päivitettiin, yksi pysyi ennallaan.

Kun synkronointi epäonnistuu

Komento päättyy tilakoodiin 1, jos lähteiden etsintä tai täsmäytys ilmoittaa virheestä, jolloin CI-vaihe epäonnistuu. JSON-raportti tulostetaan silti, joten tallenna se lokiin. Virheellinen page.json näyttää tältä:

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

Hallinnoidut sivut, joiden lähteet ovat kadonneet, poistetaan vasta virheettömän ajon jälkeen, joten synkronoinnissa epäonnistuva julkaisu ei tuhoa käytössä olevia sivuja. Poistetut sivut siirretään oletusarvoisesti roskakoriin; blockstudio/pages/orphan_action-suodatin voi palauttaa arvon trash, delete tai keep.

Suorita jokaisessa käyttöönotossa

Suorita synkronointi myös silloin, kun yksikään sivu ei ole muuttunut. Jos otat käyttöön version sisältävään hakemistoon ja vaihdat symbolisen linkin, muuttumattoman sivun malli- ja asettelupolut osoittavat yhä edelliseen versioon, kunnes seuraava synkronointi päivittää ne. Päivitys ei koske kohdetta post_content eikä muokkauspäivää.

--authoritative ja --full

Tavallinen synkronointi säilyttää toimittajien avainlohkoihin tekemät sisältömuutokset. --authoritative korvaa hallinnoidun sisällön tiedostojen sisällöllä ja voi poistaa Page Sync -lukituksen. Käytä sitä, kun tiedostojen halutaan voittavan: esimerkiksi nollattaessa testausympäristöä tai sivustoa, jonka tiedostopohjaisia sivuja ei muokata editorissa. Älä käytä sitä jokaisessa käyttöönotossa, jos sivustolla on aktiivisia toimittajia.

--full merkitsee ajon täydelliseksi täsmäytykseksi tallennetusta tunnisteesta riippumatta. Sivut vertaillaan jo jokaisella ajokerralla, joten valitsin muuttaa vain raportin arvoa fullReconciliation eikä sitä, mitkä sivut tarkistetaan. Käytä sitä, kun myöhempi vaihe käynnistää täyden uudelleenrakennuksen tämän arvon perusteella.

Kohteella PHP kirjoitetut työkalut voivat kutsua suoraan toimintoa Blockstudio\Pages::reconcile(). Se palauttaa saman raportin mutta ei tallenna tunnistetta: kutsu toimintoa Blockstudio\Pages::store_successful_source_identity(), kun julkaisun muut osat, kuten aktivoitu staattinen artefakti, on vahvistettu.

Vaihe 4: Päivitä staattinen välimuisti

Jos sivusto käyttää staattista esirenderöintiä oletustilassa signature, kohteesta WP-CLI päivitetyt sivujulkaisut eivät itsessään tyhjennä tallennettua HTML-välimuistia. Lue raportti ja tyhjennä välimuisti, jos jokin muuttui, ja lämmitä se sitten:

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

Jokainen wp bs prerender warm-ajo lisää vanhentuneet julkiset URL-osoitteet jonoon, renderöi niistä enintään warm.concurrency ja tulostaa yhteenvedon. Tässä ajossa jonon kuudesta URL-osoitteesta neljä varattiin käsittelyyn, eikä yhtäkään saatu renderöityä:

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

Jos URL-URL-osoitteen renderöinti epäonnistuu, se pysyy vanhentuneena ja lisätään uudelleen jonoon seuraavalla ajokerralla. Siksi silmukka päättyy ensimmäiseen ajoon, jossa mitään ei saada lämpimäksi, eikä odota jonon tyhjenemistä. Aikataulutettu välimuistin lämmittäjä tai seuraava anonyymi kävijä käsittelee jäljelle jääneet kohteet.

Tilassa graph URL-kohtainen URL-välimuistin lämmittäjä on pois käytöstä, eikä warm lisää mitään jonoon. Graph-sivustot korvaavat vaiheet 2 ja 3 omalla koontiprosessillaan, joka renderöi vaikutuksen alaiset URL-osoitteet ja ottaa tuloksen käyttöön atomisesti. Katso allekirjoitus- ja graph-tilat.

Vaihe 5: CI-työnkulku

Alla oleva työnkulku on esimerkki kohteelle GitHub Actions. Sama rakenne sopii mihin tahansa CI-järjestelmään: kokoa, lataa, suorita skripti palvelimella ja tyhjennä CDN-välimuisti.

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 ja cancel-in-progress: false asettavat toisen käyttöönoton jonoon käynnissä olevan taakse sen sijaan, että se peruutettaisiin kesken synkronoinnin. PHP 8.2 on kohteen Blockstudio vähimmäisversio. Korvaa viimeinen vaihe kohteen CDN välimuistin tyhjennys-API-osoitteella.

Ylläpitokomennot

Näitä ei tarvita jokaisessa julkaisussa, mutta käyttöönoton ohjeistuksen tulee tuntea ne.

Vanhojen lukkojen jonon tyhjentäminen. Ennen versiota 7.6.14 jokaisen sisältömuutoksen jäljiltä jäi .build.lock-tiedosto. Päivityksen jälkeen WP-Cron poistaa ne rajatuissa erissä. Tarkista tilanne ja tyhjennä jono kerralla:

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ättää yli tunnin vanhat tai käynnissä olevan pyynnön yhä hallussa pitämät lukot seuraavaa ajoa varten. Älä koskaan poista lukkotiedostoja käsin sivuston palvellessa liikennettä.

Ajonaikaisen välimuistin tyhjennys. wp bs cache clear tyhjentää kaiken nykyisen sivuston välimuistista, ja wp bs cache clear --scope=runtime tyhjentää yhden käyttöalueen kaikista nimiavaruuksista. Seuraava pyyntö rakentaa välimuistin alusta, joten suorita komento vähäisen liikenteen aikaan ja vain tarpeesta: syötteiden muutokset vaihtavat avaimet jo valmiiksi.

Blockstudion poistaminen. Composer-asennuksessa ei ole lisäosan käytöstäpoistokoukkua, joten mikään ei peruuta cron-tapahtumia eikä poista varhaisen palvelun drop-in-tiedostoa, kun paketti poistuu. Suorita tämä ennen riippuvuuden poistamista:

Shell
wp bs teardown

Se poistaa asennuksen omistamat cron-tapahtumat ja staattisen esirenderöinnin tilan, jättää muiden drop-in-tiedostot ja asetustiedostot rauhaan sekä varmistaa, että myöhempi uudelleenaktivointi alkaa puhtaalta pöydältä.

Seuraavat vaiheet