Μετάβαση στο περιεχόμενο

Ανάπτυξη ιστότοπου Blockstudio

Για τα blocks, αρκεί να αντιγράψετε έναν φάκελο θέματος σε έναν διακομιστή: το Blockstudio τα εντοπίζει στο σύστημα αρχείων και οι κρυφές μνήμες του εντοπίζουν μόνες τους τις αλλαγές εισόδου. Ένας πραγματικός ιστότοπος έχει περισσότερα κινούμενα μέρη. Οι σελίδες που βασίζονται σε αρχεία φτάνουν στη βάση δεδομένων μόνο όταν τις συγχρονίσετε. Μια στατική προαπόδοση εξακολουθεί να προβάλλει το χθεσινό HTML μέχρι να αντικατασταθεί. Ένα CDN μπροστά εξακολουθεί να προβάλλει ό,τι έχει αποθηκεύσει στην κρυφή μνήμη.

Αυτός ο οδηγός δημιουργεί μια διαδικασία ανάπτυξης για ένα θέμα που ονομάζεται acme και ομαδοποιεί το Blockstudio μέσω του Composer. Καλύπτει τι εκτελείται στο CI, τι εκτελείται στον διακομιστή αφού μεταφερθούν τα αρχεία, πώς να διαβάσετε την αναφορά συγχρονισμού σελίδων και ποιες εντολές wp bs ανήκουν σε μια έκδοση.

Η έκδοση με μια ματιά

  1. Δημιουργία. Το CI εγκαθιστά τις εξαρτήσεις παραγωγής Composer.
  2. Μεταφόρτωση. Το θέμα, συμπεριλαμβανομένου του vendor/, φτάνει στον διακομιστή.
  3. Συγχρονισμός σελίδων. Το wp bs pages sync ευθυγραμμίζει τις αναρτήσεις σελίδων με τα αρχεία και εκτυπώνει μια αναφορά.
  4. Ανανέωση της προσωρινής μνήμης προέλευσης. Το αποθηκευμένο HTML εκκαθαρίζεται όταν αλλάζουν σελίδες και, στη συνέχεια, θερμαίνεται ξανά.
  5. Εκκαθάριση του CDN. Τελευταία, ώστε το edge να ξαναγεμίσει από μια πρόσφατη προέλευση.

Τα βήματα 3 και 4 χρειάζονται το WP-CLI στον διακομιστή. Το παρακάτω σενάριο χρησιμοποιεί επίσης το jq για να διαβάσει το JSON.

Βήμα 1: Composer στο CI

Συμπεριλάβετε το Blockstudio στο θέμα και υποβάλετε το composer.lock, ώστε το CI να εγκαταστήσει την ακριβή έκδοση που δοκιμάσατε:

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

Στο CI, εγκαταστήστε χωρίς πακέτα ανάπτυξης:

Κέλυφος
composer install --no-dev --optimize-autoloader --no-interaction --prefer-dist

Το Blockstudio εκκινεί από τον autoloader, ενώ οι δικές του εξαρτήσεις χρόνου εκτέλεσης περιλαμβάνονται στο πακέτο και έχουν δικό τους namespace. Όταν φορτώνεται από κατάλογο vendor/, το ενσωματωμένο εργαλείο ενημέρωσης GitHub είναι απενεργοποιημένο, οπότε το Composer παραμένει ο μόνος τρόπος αλλαγής της έκδοσης.

Βήμα 2: Αποφασίστε τι πρέπει να είναι εγγράψιμο

Το Blockstudio γράφει αρχεία που δημιουργούνται κατά τον χρόνο εκτέλεσης. Μάθετε πού, πριν από την αντικατάσταση ή το κλείδωμα ενός καταλόγου κατά την ανάπτυξη:

  • Οι προσωρινές μνήμες χρόνου εκτέλεσης βρίσκονται από προεπιλογή στο wp-content/blockstudio/cache/. Αν προτιμάτε, ορίστε το cache.path σε έναν αποκλειστικό εγγράψιμο τόμο. Η αλλαγή της διαδρομής ξεκινά με κενή προσωρινή μνήμη.
  • Τα μεταγλωττισμένα στοιχεία μπλοκ γράφονται από προεπιλογή σε έναν φάκελο _dist δίπλα σε κάθε μπλοκ. Αν ο κατάλογος έκδοσης είναι μόνο για ανάγνωση ή αντικαθίσταται σε κάθε ανάπτυξη, ορίστε το assets.output σε cache, ώστε να αποθηκεύονται στον κατάλογο της προσωρινής μνήμης:
JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "assets": {
    "output": "cache"
  }
}

Δεν χρειάζεται να εκκαθαρίζετε τις προσωρινές μνήμες κατά την ανάπτυξη. Κάθε καταχώριση προσωρινής μνήμης έχει κλειδί που βασίζεται στις εισόδους της, μεταξύ άλλων στα αρχεία μπλοκ, τις ρυθμίσεις, το ενεργό θέμα και τα πρόσθετα, καθώς και στις εκδόσεις WordPress, PHP και Blockstudio, οπότε μια έκδοση που τις αλλάζει λαμβάνει νέα κλειδιά. Στα production και staging, το Blockstudio εμπιστεύεται ένα επικυρωμένο στιγμιότυπο παρακολούθησης για 20 δευτερόλεπτα πριν ελέγξει ξανά τα αρχεία. Έτσι, μπορεί να χρειαστούν έως και 20 δευτερόλεπτα μέχρι να εντοπιστεί μια αλλαγή. Το φίλτρο blockstudio/cache/watch_debounce αλλάζει αυτό το χρονικό διάστημα.

Βήμα 3: Συγχρονισμός σελίδων

Οι αναρτήσεις σελίδων αλλάζουν μόνο μέσω ρητού συγχρονισμού. Τα αιτήματα frontend, διαχειριστή, Ajax, REST, cron και τα συνήθη αιτήματα WP-CLI δεν εντοπίζουν πηγές σελίδων ούτε γράφουν αναρτήσεις σελίδων. Η διαδικασία ανάπτυξης πρέπει να το ζητήσει:

Κέλυφος
wp bs pages sync --format=json

Σε έναν ιστότοπο του οποίου το θέμα έχει δύο σελίδες, τις about και contact, η πρώτη εκτέλεση τις δημιουργεί:

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

Πώς να το διαβάσετε:

  • Τα created, updated, unchanged, removed και failed μετρούν σελίδες. Αν το αποτύπωμα της πηγής μιας σελίδας δεν έχει αλλάξει, δεν γίνονται εγγραφές ανάρτησης ή μεταδεδομένων ανάρτησης και δεν ενεργοποιούνται άγκιστρα ενημέρωσης.
  • Κάθε εκτέλεση συγκρίνει ολόκληρο το απόθεμα σελίδων. Το fullReconciliation δηλώνει αν η εκτέλεση μετρά ως πλήρης επανασυμφωνία: true στην πρώτη εκτέλεση, όταν υπάρχει --full ή όταν έχει αλλάξει η ίδια η μηχανή συγχρονισμού· και false όταν υπάρχει αναγνωριστικό από προηγούμενο επιτυχημένο συγχρονισμό. Τα επόμενα εργαλεία μπορούν να το χρησιμοποιήσουν για να αποφασίσουν αν θα αναδημιουργήσουν τα πάντα.
  • Το sourceIdentity είναι ένα ντετερμινιστικό αποτύπωμα του αποθέματος σελίδων και της μηχανής συγχρονισμού. Η εντολή το αποθηκεύει μετά από επιτυχημένη εκτέλεση.

Χωρίς το --format=json, η εντολή εκτυπώνει μία συνοπτική γραμμή και μια γραμμή επιτυχίας. Σε ένα αρχείο καταγραφής CI, που δεν είναι τερματικό, η γραμμή διαχωρίζεται με στηλοθέτες:

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

Αυτή η εκτέλεση ακολούθησε μια επεξεργασία του about/index.php: μία σελίδα ενημερώθηκε και μία παρέμεινε αμετάβλητη.

Σε περίπτωση αποτυχίας συγχρονισμού

Η εντολή τερματίζεται με κατάσταση 1 όταν ο εντοπισμός ή η επανασυμφωνία αναφέρει σφάλμα, με αποτέλεσμα να αποτυγχάνει το βήμα CI. Η αναφορά JSON εξακολουθεί να εκτυπώνεται, οπότε καταγράψτε την. Ένα κακοσχηματισμένο page.json μοιάζει ως εξής:

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

Οι διαχειριζόμενες σελίδες των οποίων οι πηγές εξαφανίστηκαν διαγράφονται μόνο αφού ολοκληρωθεί μια εκτέλεση χωρίς σφάλματα, ώστε μια έκδοση που αποτυγχάνει να συγχρονιστεί να μην καταστρέφει ενεργές σελίδες. Από προεπιλογή, οι σελίδες που αφαιρούνται μεταφέρονται στον κάδο απορριμμάτων· το φίλτρο blockstudio/pages/orphan_action μπορεί να επιστρέψει trash, delete ή keep.

Εκτελείτε τον συγχρονισμό σε κάθε ανάπτυξη

Εκτελείτε τον συγχρονισμό ακόμη κι όταν δεν έχει αλλάξει καμία σελίδα. Αν αναπτύσσετε σε καταλόγους εκδόσεων και αλλάζετε έναν συμβολικό σύνδεσμο, μια αμετάβλητη σελίδα εξακολουθεί να παραπέμπει στις διαδρομές προτύπων και διάταξης της προηγούμενης έκδοσης, μέχρι ο επόμενος συγχρονισμός να τις ανανεώσει. Αυτή η ανανέωση δεν αλλάζει το post_content ούτε την ημερομηνία τροποποίησης.

--authoritative και --full

Ένας κανονικός συγχρονισμός διατηρεί το περιεχόμενο που άλλαξαν οι συντάκτες μέσα σε μπλοκ με κλειδιά. Το --authoritative αντικαθιστά το διαχειριζόμενο περιεχόμενο με εκείνο των αρχείων και μπορεί να καταργήσει ένα κλείδωμα Page Sync. Χρησιμοποιήστε το όταν υπερισχύουν τα αρχεία, για παράδειγμα κατά την επαναφορά ενός περιβάλλοντος σταδιοποίησης ή σε έναν ιστότοπο όπου κανείς δεν επεξεργάζεται στον επεξεργαστή σελίδες που βασίζονται σε αρχεία. Μην το συμπεριλαμβάνετε σε κάθε ανάπτυξη ενός ιστότοπου με ενεργούς συντάκτες.

Το --full δηλώνει την εκτέλεση ως πλήρη επανασυμφωνία, ανεξάρτητα από το αποθηκευμένο αναγνωριστικό. Η σύγκριση των σελίδων είναι ήδη πλήρης σε κάθε εκτέλεση, επομένως η σημαία αλλάζει την τιμή fullReconciliation στην αναφορά, όχι τις σελίδες που ελέγχονται. Περάστε την όταν ένα επόμενο βήμα βασίζει την πλήρη αναδημιουργία σε αυτήν την τιμή.

Τα εργαλεία που είναι γραμμένα σε PHP μπορούν να καλέσουν απευθείας το Blockstudio\Pages::reconcile(). Επιστρέφει την ίδια αναφορά, αλλά δεν αποθηκεύει το αναγνωριστικό: καλέστε το Blockstudio\Pages::store_successful_source_identity() μόλις επαληθευτεί η υπόλοιπη έκδοση, όπως ένα ενεργοποιημένο στατικό τεχνούργημα.

Βήμα 4: Ανανέωση της στατικής προσωρινής μνήμης

Αν ο ιστότοπος χρησιμοποιεί στατική προαπόδοση στην προεπιλεγμένη λειτουργία signature, οι αναρτήσεις σελίδων που ενημερώνονται από το WP-CLI δεν εκκαθαρίζουν από μόνες τους το αποθηκευμένο HTML. Διαβάστε την αναφορά και εκκαθαρίστε την προσωρινή μνήμη αν έχει αλλάξει κάτι· έπειτα θερμάνετέ την:

Κέλυφος
#!/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}'

Κάθε εκτέλεση του wp bs prerender warm προσθέτει τις παρωχημένες δημόσιες διευθύνσεις URL στην ουρά, αποδίδει έως και warm.concurrency από αυτές και εκτυπώνει μια σύνοψη. Σε αυτήν την εκτέλεση, τέσσερις από τις έξι διευθύνσεις URL της ουράς αναλήφθηκαν και η απόδοση και των τεσσάρων απέτυχε:

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

Ένα URL που αποτυγχάνει να αποδοθεί παραμένει παρωχημένο και προστίθεται ξανά στην ουρά στην επόμενη εκτέλεση. Γι’ αυτό ο βρόχος σταματά στην πρώτη εκτέλεση που δεν θερμαίνει τίποτα, αντί να περιμένει να αδειάσει η ουρά. Ό,τι απομείνει αναλαμβάνει ο προγραμματισμένος μηχανισμός προθέρμανσης ή η επόμενη ανώνυμη επίσκεψη.

Στη λειτουργία graph, ο μηχανισμός προθέρμανσης ανά URL είναι απενεργοποιημένος και το warm δεν προσθέτει τίποτα στην ουρά. Οι ιστότοποι Graph αντικαθιστούν τα βήματα 2 και 3 με τη δική τους διαδικασία δημιουργίας, η οποία αποδίδει τις επηρεαζόμενες διευθύνσεις URL και ενεργοποιεί το αποτέλεσμα ατομικά. Δείτε τις λειτουργίες υπογραφής και γραφήματος.

Βήμα 5: Η ροή εργασίας CI

Η παρακάτω ροή εργασίας είναι ένα παράδειγμα GitHub Actions. Η δομή εφαρμόζεται και σε κάθε σύστημα CI: δημιουργία, μεταφόρτωση, εκτέλεση του σεναρίου στον διακομιστή, εκκαθάριση του 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 με cancel-in-progress: false προσθέτει μια δεύτερη αποστολή στην ουρά πίσω από μια εκτελούμενη ανάπτυξη, αντί να την ακυρώνει στη μέση του συγχρονισμού. Το PHP 8.2 είναι η ελάχιστη έκδοση του Blockstudio. Αντικαταστήστε το τελευταίο βήμα με το API εκκαθάρισης του CDN σας.

Εντολές συντήρησης

Δεν χρειάζεται να τις εκτελείτε σε κάθε έκδοση, αλλά ο οδηγός διαδικασιών ανάπτυξης πρέπει να τις περιλαμβάνει.

Εκκαθάριση της εκκρεμότητας παλιών κλειδωμάτων. Οι εκδόσεις πριν από το 7.6.14 άφηναν πίσω ένα αρχείο .build.lock για κάθε αλλαγή περιεχομένου. Μετά την αναβάθμιση, το WP-Cron τα αφαιρεί σε περιορισμένες παρτίδες. Για έλεγχο και άμεση εκκαθάριση της εκκρεμότητας:

Κέλυφος
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 αφήνει τα κλειδώματα που είναι νεότερα από μία ώρα ή εξακολουθούν να δεσμεύονται από ένα αίτημα σε εκτέλεση για την επόμενη φορά. Μην διαγράφετε ποτέ αρχεία κλειδώματος με το χέρι όσο ο ιστότοπος εξυπηρετεί επισκεψιμότητα.

Εκκαθάριση της προσωρινής μνήμης χρόνου εκτέλεσης. Το wp bs cache clear εκκαθαρίζει τα πάντα για τον τρέχοντα ιστότοπο, ενώ το wp bs cache clear --scope=runtime εκκαθαρίζει ένα πεδίο εφαρμογής σε όλους τους χώρους ονομάτων. Το επόμενο αίτημα δημιουργεί ξανά την προσωρινή μνήμη από την αρχή, οπότε εκτελέστε την εντολή όταν η κίνηση είναι χαμηλή και μόνο αν υπάρχει λόγος: οι αλλαγές στις εισόδους ανανεώνουν ήδη τα κλειδιά.

Αφαίρεση του Blockstudio. Μια εγκατάσταση Composer δεν διαθέτει άγκιστρο απενεργοποίησης πρόσθετου, επομένως τίποτα δεν ακυρώνει τα συμβάντα cron ούτε αφαιρεί το drop-in πρώιμης εξυπηρέτησης όταν εξαφανίζεται το πακέτο. Εκτελέστε αυτό πριν αφαιρέσετε την εξάρτηση:

Κέλυφος
wp bs teardown

Αφαιρεί τα συμβάντα cron και την κατάσταση στατικής προαπόδοσης που ανήκουν σε αυτήν την εγκατάσταση, αφήνει ανέπαφα τα ξένα drop-in και τα αρχεία ρυθμίσεων και επιτρέπει σε μελλοντική επανενεργοποίηση να ξεκινήσει καθαρά.

Επόμενα βήματα