Synchronizace obsahu
Blockstudio je postavený na pracovním postupu založeném na souborech: bloky, pole, šablony, assety, vzory a stránky založené na souborech mohou být součástí vašeho projektu. Content Sync tento model rozšiřuje na vybraný obsah databáze WordPress pro týmy, které chtějí mít v git také spravované příspěvky, termíny, vztahy a deklarovaná metadata.
Jde o postup WP-CLI, nikoli o živou replikaci databáze. Při stažení se povolené příspěvky, postmeta, termíny, termmeta a vztahy mezi příspěvky a termíny převedou na přenosné soubory v šabloně. Při nahrání se tyto soubory použijí v jiném prostředí pomocí stabilních UID a přepíší se pouze reference, které výslovně deklarujete.
Poznámka
Synchronizace obsahu probíhá na vyžádání. Nespouští se při každém požadavku správce. Dokud není
content.enablednastaveno natrue, příkazy vracejí přeskočený řádek.
Kdy použít synchronizaci obsahu
Synchronizaci obsahu použijte pro skupiny obsahu, které je důležité verzovat, kontrolovat a přesouvat mezi prostředími:
- strukturovaný obsah, například členové týmu, lokality, případové studie, produkty, položky dokumentace nebo stránky kampaní
- taxonomie a vztahy, které patří k těmto sadám obsahu
- povolená metadata, která lze bezpečně commitnout a potřebují stabilní reference
- malé až středně velké sady obsahu, u kterých je kontrola souborů v git stále praktická
Obecně lze synchronizaci obsahu pohodlně používat pro desítky až stovky řádků; při strukturovaných datech s malým počtem změn rozdělených do úzce zaměřených typů příspěvků zvládne i nižší tisíce. Není určena k zrcadlení celé produkční databáze, často upravovaného redakčního obsahu, protokolů, objednávek, analytických dat, odeslaných formulářů, relací ani jiných rozsáhlých nebo často měněných dat. Pokud se vygenerované soubory obtížně kontrolují, nahrávání trvá příliš dlouho na to, aby se dalo snadno posoudit, nebo se většina řádků mění mimo proces nasazení, použijte místo toho zálohu databáze, migraci nebo nástroj pro import a export.
Binární soubory médií se nekopírují. Reference na přílohy lze zaznamenat do manifestu a ověřit, ale samotné soubory musí být v cílovém prostředí k dispozici.
Konfigurace
Povolte synchronizaci 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 seznam povolených typů; je-li prázdný, synchronizace obsahu se příspěvků nedotkne. taxonomies je seznam již registrovaných taxonomií, jejichž termíny a vztahy k příspěvkům se mají synchronizovat. Blockstudio neregistruje definice taxonomií ze souborů synchronizace obsahu. Povolená metadata příspěvků a termínů se určují pomocí meta.include; meta.exclude má vždy přednost.
Varování
Považujte
meta.includeza hranici commitu. Synchronizované soubory mají být uloženy v git, proto nezahrnujte klíče obsahující tajné údaje, tokeny, přihlašovací údaje ani osobní údaje.wp bs content statushlásí varovné řádky, když povolený klíč metadat vypadá jako citlivý.
content.id se ukládá k synchronizovaným entitám jako _blockstudio_content_set. Kontrola mazání a vlastnictví se řídí touto hodnotou, takže jedna skupina obsahu nemůže smazat obsah jiné skupiny.
Příspěvky spravované synchronizací stránek jsou ve výchozím nastavení vyloučeny. Je-li zapnuto includePageSyncManaged, synchronizace obsahu může synchronizovat jejich nakonfigurovaná metadata, ale jejich post_content zůstává ve správě synchronizace stránek.
Tyto projekce obsahují "bodyOwner": "page-sync". Pull hlásí zápis JSON jako obsahující pouze metadata a přidává řádek těla skipped, místo aby příspěvek zobrazil jako příspěvek s prázdným tělem. Nevytváří ani nemaže sourozenecký soubor .html. Existující kopie k revizi se zachová a příkaz push ji ignoruje. Stejné zprávy o vlastnictví jsou součástí výstupu při zkušebním spuštění.
V jiném prostředí nejprve spusťte Page Sync. Projekce s bodyOwner: "page-sync" musí odkazovat na existující příspěvek spravovaný pomocí Page Sync; push odmítne vytvořit prázdnou náhradní položku nebo použít kontrolní kopii textu příspěvku. Projekce bez tohoto markeru ze starších verzí jsou nadále podporovány.
Autoři jsou ve výchozím nastavení ignorováni, protože uživatelé se nesynchronizují. Nastavte authors: "login", aby se přihlašovací jméno autora ukládalo do souborů příspěvků a při nahrání se přiřadilo existujícímu uživateli. Chybějící uživatelé způsobí chybu předběžné kontroly; synchronizace obsahu uživatele nevytváří.
Pří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 přenáší obsah databáze do souborů. Přiřadí _blockstudio_content_uid příspěvkům v určeném rozsahu, které jej ještě nemají, a ohlásí zastaralé soubory, jejichž zdroj v databázi už neexistuje. Zastaralé soubory se při stažení nemažou.
push použije soubory v aktuální databázi. Před zápisem ověří plán a zablokuje nevyřešené deklarované reference, konflikty slugů, uzamčené entity a chybějící typy příspěvků.
status porovná soubory s databází a nahlásí stav každé entity jako unchanged, would-update, missing-db, conflict, locked nebo orphaned. Před uložením upozorní také na povolené klíče metadat, které vypadají jako tajné údaje, a na číselná ID v tělech značek bloků, protože synchronizace obsahu nepřepisuje ID v souborech .html.
Pomocí --dry-run můžete zkontrolovat stažení nebo nahrání bez zápisu. Pomocí push --prune --yes odstraníte z databáze entity vlastněné danou skupinou obsahu, které už v souborech nejsou.
Bezpečnost při chybě
push analyzuje a ověřuje celý zdrojový plán, než začne zapisovat nebo odebírat. Chybně formátované JSON, nevyřešené deklarované reference, neplatné vlastnictví a další chyby při předběžné kontrole zablokují destruktivní fázi. Odebírání zůstává omezeno na nakonfigurované typy příspěvků, taxonomie a content.id.
pull zapíše každý promítnutý soubor před zaznamenáním synchronizace dané entity. Chyba zápisu do systému souborů se vrátí jako chybový řádek a neaktualizuje uložený stav synchronizace dané entity.
Zpracování příloh se řídí content.media. Při použití "manifest" musí cílové prostředí obsahovat odkazované UID příloh. Při použití "none" se deklarované reference na přílohy z přenositelného výstupu záměrně odstraní, místo aby se zachovala ID specifická pro dané prostředí.
Soubory
Content Sync zapisuje soubory do nakonfigurovaného content.path:
content/
posts/
team_member/
jane.9b1c0e6e.json
jane.9b1c0e6e.html
terms/
category/
leadership.5e900000.json
media/
manifest.json
Soubory příspěvků .json obsahují identitu, pole příspěvku, vztahy k termům, deklarovaná metadata a kódování metadat. Sousední soubor .html ukládá post_content jako nezpracované značky bloků a vynechá se, pokud je obsah prázdný. Soubory termů .json obsahují identitu, taxonomii, slug, název, popis, UID nadřazeného termu, deklarovaná metadata termu a kódování metadat.
Druhým případem, kdy soubor .html chybí, je text spravovaný pomocí Page Sync, který je označen výše pomocí bodyOwner. U běžných příspěvků, jejichž text je prázdný, pull odstraní starý soubor s textem a uvede jej v samostatném řádku deleted pro text.
{
"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 synchronizace:
| Klíč metadat | Účel |
|---|---|
_blockstudio_content_uid |
Přenositelná identita obsahu |
_blockstudio_content_set |
Jmenný prostor sady obsahu z content.id |
_blockstudio_content_source |
Cesta ke zdrojovému souboru relativní vůči šabloně |
_blockstudio_content_fingerprint |
Otisk poslední synchronizace souboru/databáze |
_blockstudio_content_locked |
Pravdivá hodnota zabrání tomu, aby push entitu přepsal |
Reference
Content Sync nikdy nepředpokládá, že celé číslo je ID. Reference se přepisují pouze tehdy, jsou-li nakonfigurovány v meta.references.
{
"meta": {
"references": {
"_related_posts": { "kind": "post", "path": "*" },
"_topic": { "kind": "term" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
}
}
Při stažení se místní ID na těchto cestách změní na přenositelná UID. Při odeslání se UID v aktuální databázi převedou zpět na místní ID.
Nadřazené příspěvky, nadřazené termy a vztahy mezi příspěvky a termy jsou strukturální reference spravované nástrojem Content Sync a automaticky se ukládají jako UID. Nakonfigurované taxonomie se zapisují do souborů příspěvků, i když jsou prázdné; prázdné pole při odeslání vymaže vztahy dané taxonomie.
Reference na přílohy se ověřují, neimportují. Při použití media: "manifest" jsou odkazované přílohy uvedeny v content/media/manifest.json; odeslání vyžaduje, aby odkazované UID přílohy existovalo lokálně. Při použití media: "none" se deklarované reference na přílohy z přenositelných souborů vynechají. Protože se vynechaný klíč při odesílání nepoužije, cílový příspěvek si zachová svá aktuální metadata příloh.
Postup zajištění přenositelnosti
- Zaregistrujte cílový typ příspěvku v každém prostředí.
- Nakonfigurujte
content.postTypes,meta.includea všechny deklarované reference. - Ve zdrojovém prostředí spusťte
wp bs content pull. - Potvrďte v Gitu vygenerované soubory.
- V cílovém prostředí spusťte
wp bs content push. - Spusťte
wp bs content statusa ověřte, že databáze odpovídá souborům.
Soubory jsou hlavním zdrojem pravdy pro push. Databáze se zpětně zachytí do souborů pomocí pull.
Rozsah
Content Sync podporuje:
- příspěvky z povolených typů příspěvků
- povolená metadata příspěvků
- termy z povolených registrovaných taxonomií
- povolená metadata termů
- vztahy mezi příspěvky a termy
- deklarované reference
post,attachmentaterm - přenositelná UID příspěvků a termů a vlastnictví sad obsahu
- standardní vyloučení synchronizace stránek
- manifest příloh a předběžné ověřování
pull,push,status,--dry-run,--prunea zpracování uzamčených entit
Zachycování definic taxonomií, kopírování binárních dat médií a přepisování ID ve značkách bloků nejsou podporovány.