Synchronizácia obsahu
Blockstudio je postavený na súborovom pracovnom postupe: bloky, polia, šablóny, prostriedky, vzory aj stránky uložené v súboroch môžu byť súčasťou projektu. Synchronizácia obsahu rozširuje tento model o vybraný obsah z databázy WordPress pre tímy, ktoré chcú mať v git aj kurátorsky spravované príspevky, výrazy, vzťahy a deklarované metadáta.
Ide o pracovný postup WP-CLI, nie o živú replikáciu databázy. Pri načítaní sa povolené príspevky, postmeta, výrazy, termmeta a vzťahy medzi príspevkami a výrazmi premietnu do prenosných súborov v téme. Pri odoslaní sa tieto súbory použijú v inom prostredí. Využívajú sa pritom stabilné UID a prepisujú sa iba výslovne deklarované odkazy.
Poznámka
Synchronizácia obsahu sa spúšťa na požiadanie. Nevykonáva sa pri každej požiadavke administrácie. Kým nie je
content.enabledtrue, príkazy vracajú preskočený riadok.
Kedy použiť synchronizáciu obsahu
Synchronizáciu obsahu použite na súbory obsahu, ktoré chcete verzovať, kontrolovať a presúvať medzi prostrediami:
- štruktúrovaný obsah, napríklad členovia tímu, lokality, prípadové štúdie, produkty, položky dokumentácie alebo stránky kampaní
- taxonómie a vzťahy prislúchajúce k týmto súborom obsahu
- povolené metadáta, ktoré možno bezpečne uložiť do repozitára a ktoré potrebujú stabilné odkazy
- malé až stredne veľké súbory obsahu, pri ktorých je kontrola súborov v git stále praktická
Vo všeobecnosti je synchronizácia obsahu vhodná pre desiatky až stovky riadkov a zvládne aj niekoľko tisíc, ak sú údaje štruktúrované, menia sa zriedka a sú rozdelené do samostatných typov príspevkov. Nie je určená na zrkadlenie celej produkčnej databázy, často aktualizovaného redakčného obsahu, protokolov, objednávok, analytických údajov, odoslaných formulárov, relácií ani iných rozsiahlych alebo často sa meniacich údajov. Ak sa vygenerované súbory ťažko kontrolujú pre množstvo zmien, odoslanie zmien sa príliš dlho vyhodnocuje alebo sa väčšina riadkov mení mimo pracovného postupu nasadzovania, použite zálohu databázy, migráciu alebo nástroj na import a export.
Binárne súbory médií sa nekopírujú. Odkazy na prílohy možno zaznamenať do manifestu a overiť, ale samotné súbory musia byť dostupné v cieľovom prostredí.
Konfigurácia
Povoľte synchronizáciu obsahu v blockstudio.json:
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"content": {
"enabled": true,
"id": "default",
"path": "content",
"includePageSyncManaged": false,
"authors": "ignore",
"postTypes": ["team_member"],
"meta": {
"include": ["_my_*"],
"exclude": ["_edit_lock", "_edit_last", "_wp_old_slug"],
"references": {
"_thumbnail_id": { "kind": "attachment" },
"_related_posts": { "kind": "post", "path": "*" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
},
"taxonomies": [],
"media": "manifest"
}
}
postTypes je zoznam povolených položiek. Ak je prázdny, synchronizácia obsahu sa nedotkne príspevkov. taxonomies obsahuje povolené už zaregistrované taxonómie, ktorých výrazy a vzťahy k príspevkom sa majú synchronizovať. Blockstudio neregistruje definície taxonómií zo súborov synchronizácie obsahu. Metadáta príspevkov a výrazov sa povoľujú cez meta.include; vždy má prednosť meta.exclude.
Upozornenie
Považujte
meta.includeza hranicu toho, čo možno odovzdať do repozitára. Synchronizované súbory majú byť uložené v git, preto nezahŕňajte kľúče obsahujúce tajné údaje, tokeny, prihlasovacie údaje ani osobné údaje.wp bs content statusupozorňuje na riadky, v ktorých povolený kľúč metadát vyzerá ako citlivý údaj.
content.id sa v synchronizovaných entitách ukladá ako _blockstudio_content_set. Kontrola odstraňovania a vlastníctva sa riadi touto hodnotou, takže jedna množina obsahu nemôže odstrániť obsah inej množiny.
Príspevky spravované synchronizáciou stránok sú predvolene vylúčené. Ak je povolené includePageSyncManaged, synchronizácia obsahu môže synchronizovať ich nakonfigurované metadáta, no ich post_content naďalej spravuje synchronizácia stránok.
Tieto projekcie obsahujú "bodyOwner": "page-sync". Príkaz Pull nahlási zápis JSON ako metadáta a pridá riadok tela skipped namiesto toho, aby príspevok zobrazil s prázdnym telom. Nezapíše ani neodstráni susedný súbor .html. Existujúca kontrolná kópia sa zachová a príkaz push ju ignoruje. Rovnaké správy o vlastníctve sú zahrnuté vo výstupe skúšobného spustenia.
V inom prostredí najprv spustite Page Sync. Projekcia s bodyOwner: "page-sync" musí odkazovať na existujúci príspevok spravovaný cez Page Sync; príkaz push odmietne vytvoriť prázdnu náhradnú položku alebo použiť revíznu kópiu tela daného príspevku. Projekcie bez tejto značky zo starších verzií sú naďalej podporované.
Autori sa predvolene ignorujú, pretože používatelia sa nesynchronizujú. Nastavením authors: "login" uložíte do súborov príspevkov prihlasovacie meno autora a pri odoslaní ho priradíte k existujúcemu používateľovi. Ak používateľ neexistuje, kontrola pred vykonaním skončí chybou; synchronizácia obsahu používateľov nevytvára.
Príkazy
wp bs content pull [--post-type=<type>] [--taxonomy=<taxonomy>] [--dry-run]
wp bs content push [--dry-run] [--prune] [--yes]
wp bs content status
pull zachytí obsah databázy do súborov. Príspevkom, na ktoré sa vzťahuje, priradí _blockstudio_content_uid, ak ho ešte nemajú, a nahlási zastarané súbory, ktorých zdrojový záznam v databáze už neexistuje. Zastarané súbory sa pri načítaní neodstraňujú.
push použije súbory v aktuálnej databáze. Pred zápisom overí plán a zablokuje nevyriešené deklarované odkazy, konflikty slugov, uzamknuté entity a chýbajúce typy príspevkov.
status porovná súbory s databázou a každú entitu označí ako unchanged, would-update, missing-db, conflict, locked alebo orphaned. Pred odovzdaním zmien tiež upozorní na povolené kľúče metadát, ktoré vyzerajú ako tajné údaje, a na číselné ID v telách značiek blokov, pretože synchronizácia obsahu neprepisuje ID v súboroch .html.
Pomocou --dry-run skontrolujete načítanie alebo odoslanie bez zápisu. Pomocou push --prune --yes odstránite z databázy entity vlastnené množinou obsahu, ktoré už v súboroch neexistujú.
Bezpečnosť pri zlyhaní
push analyzuje a overuje celý zdrojový plán pred zapisovaním alebo
odstraňovaním. Chybne formátované JSON, nevyriešené deklarované odkazy, neplatné vlastníctvo a
ďalšie zlyhania predbežnej kontroly zablokujú deštruktívnu fázu. Odstraňovanie je obmedzené
na nakonfigurované typy príspevkov, taxonómie a content.id.
pull zapisuje každý premietnutý súbor pred zaznamenaním synchronizácie danej entity. Ak zápis do súborového systému zlyhá, výsledkom je chybový riadok a uložený stav synchronizácie danej entity sa nezmení.
Spracovanie príloh sa riadi podľa content.media. Pri nastavení "manifest" musia referencované UID príloh existovať v cieľovom prostredí. Pri nastavení "none" sa deklarované odkazy na prílohy zámerne odstránia z prenositeľného výstupu, aby sa nezachovali ID špecifické pre dané prostredie.
Súbory
Content Sync zapisuje súbory do nakonfigurovaného content.path:
content/
posts/
team_member/
jane.9b1c0e6e.json
jane.9b1c0e6e.html
terms/
category/
leadership.5e900000.json
media/
manifest.json
Súbory príspevkov .json uchovávajú identitu, polia príspevku, vzťahy k výrazom, deklarované metaúdaje a kódovanie metaúdajov. Susedný súbor .html uchováva post_content ako surové blokové značky a pri prázdnom obsahu sa vynechá. Súbory výrazov .json uchovávajú identitu, taxonómiu, slug, názov, opis, UID nadradeného výrazu, deklarované termmeta a kódovanie metaúdajov.
Druhým prípadom, keď súbor .html neexistuje, je telo spravované cez Page Sync, ktoré je identifikované vyššie pomocou bodyOwner. Pri bežných príspevkoch, ktorých telo sa vyprázdni, príkaz pull odstráni starý súbor tela a uvedie ho v samostatnom riadku tela deleted.
{
"uid": "9b1c0e6e-0000-4000-9000-000000000000",
"type": "team_member",
"status": "publish",
"slug": "jane",
"title": "Jane",
"parent": null,
"menuOrder": 0,
"terms": {
"category": ["5e900000-0000-4000-9000-000000000000"]
},
"meta": {
"_my_subtitle": "Creative Director",
"_thumbnail_id": "a1b2c3d4-0000-4000-9000-000000000000"
},
"metaEncoding": {
"_my_subtitle": "scalar",
"_thumbnail_id": "scalar"
}
}
Uložený stav synchronizácie:
| Kľúč metaúdajov | Účel |
|---|---|
_blockstudio_content_uid |
Prenositeľná identita obsahu |
_blockstudio_content_set |
Priestor názvov množiny obsahu z content.id |
_blockstudio_content_source |
Cesta k zdrojovému súboru vzhľadom na tému |
_blockstudio_content_fingerprint |
Odtlačok naposledy synchronizovaného súboru/databázy |
_blockstudio_content_locked |
Pravdivá hodnota zabraňuje prepísaniu entity pri odoslaní |
Odkazy
Content Sync nikdy nepredpokladá, že celé číslo je ID. Odkazy sa prepíšu iba vtedy, keď sú nakonfigurované v meta.references.
{
"meta": {
"references": {
"_related_posts": { "kind": "post", "path": "*" },
"_topic": { "kind": "term" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
}
}
Pri sťahovaní sa lokálne ID na týchto cestách zmenia na prenositeľné UID. Pri odosielaní sa UID v aktuálnej databáze spätne prevedú na lokálne ID.
Nadradené príspevky, nadradené výrazy a vzťahy príspevkov k výrazom sú štrukturálne odkazy spravované službou Content Sync a automaticky sa ukladajú ako UID. Nakonfigurované taxonómie sa zapisujú do súborov príspevkov aj vtedy, keď sú prázdne; prázdne pole pri odoslaní vymaže vzťahy danej taxonómie.
Odkazy na prílohy sa overujú, neimportujú. Pri nastavení media: "manifest" sa referencované prílohy uvádzajú v content/media/manifest.json; odoslanie vyžaduje, aby referencované UID prílohy existovalo lokálne. Pri nastavení media: "none" sa deklarované odkazy na prílohy vynechávajú z prenositeľných súborov. Keďže vynechaný kľúč sa pri odosielaní nepoužije, existujúci cieľový príspevok si zachová svoje aktuálne metaúdaje prílohy.
Pracovný postup prenositeľnosti
- Zaregistrujte typ cieľového príspevku v každom prostredí.
- Nakonfigurujte
content.postTypes,meta.includea všetky deklarované odkazy. - V zdrojovom prostredí spustite
wp bs content pull. - Potvrďte v commite vygenerované súbory.
- V cieľovom prostredí spustite
wp bs content push. - Spustite
wp bs content statusa overte, či databáza zodpovedá súborom.
Pre push sú zdrojom pravdy súbory. Databáza sa spätne zachytí do súborov pomocou pull.
Rozsah
Content Sync podporuje:
- príspevky z povolených typov príspevkov
- povolené postmeta
- výrazy z povolených registrovaných taxonómií
- povolené termmeta
- vzťahy príspevkov k výrazom
- deklarované odkazy
post,attachmentaterm - prenositeľné UID príspevkov a výrazov a vlastníctvo množín obsahu
- predvolené vylúčenie Page Sync
- manifest príloh a predbežné overovanie
pull,push,status,--dry-run,--prunea spracovanie uzamknutých entít
Zachytávanie definícií taxonómií, kopírovanie binárnych súborov médií a prepisovanie ID v blokových značkách nie sú podporované.