Синхронизиране на съдържание
Blockstudio е изграден около работен процес с приоритет на файловете: блокове, полета, шаблони, ресурси, шаблони за секции и страници, базирани на файлове, могат да се намират във вашия проект. Content Sync разширява този модел до избрано WordPress съдържание от базата данни за екипи, които искат също подбрани публикации, термини, връзки и декларирани метаданни в git.
Това е работен процес WP-CLI, а не репликация на база данни в реално време. При изтегляне синхронизирането на съдържание извежда разрешените публикации, postmeta, термини, termmeta и връзки между публикации и термини в преносими файлове във вашата тема. При качване то прилага тези файлове към друга среда, използвайки стабилни UID и пренаписвайки само изрично декларираните от вас препратки.
Забележка
Синхронизирането на съдържание се изпълнява при поискване. То не стартира при всяка заявка на администратора. Командите връщат ред със състояние „пропуснато“, докато
content.enabledне бъдеtrue.
Кога да използвате синхронизирането на съдържание
Използвайте синхронизирането на съдържание за набори от съдържание, които е важно да версионирате, преглеждате и премествате между среди:
- структурирано съдържание, като членове на екипа, местоположения, казуси, продукти, документационни записи или кампанийни страници
- таксономии и връзки, свързани с тези набори от съдържание
- разрешени метаданни, чието записване в хранилище е безопасно и за които са нужни стабилни препратки
- малки до средни набори от съдържание, при които преглеждането на файлове в git остава практично
Като ориентир, синхронизирането на съдържание е подходящо за десетки или стотици редове и може да работи и с няколко хиляди, когато данните са структурирани, рядко се променят и са разделени на целенасочени типове публикации. То не е предназначено за огледално копиране на цяла производствена база данни, редакционно съдържание с голям трафик, регистрационни файлове, поръчки, аналитични данни, подавания на формуляри, сесии или други данни с голям обем или чести промени. Ако генерираните файлове станат трудни за преглед заради излишен шум, преценяването на промените при качване отнема твърде дълго или повечето редове се променят извън работния процес по внедряване, използвайте вместо това архивиране на база данни, миграция или инструмент за импортиране и експортиране.
Медийните двоични файлове не се копират. Препратките към прикачени файлове могат да бъдат записани в манифест и валидирани, но самите файлове трябва да съществуват в целевата среда.
Конфигурация
Активирайте синхронизирането на съдържание в 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 е списък с разрешени типове. Ако е празен, синхронизирането на съдържание не обработва публикации. taxonomies е списък с разрешени вече регистрирани таксономии, чиито термини и връзки с публикации трябва да се синхронизират. Blockstudio не регистрира дефиниции на таксономии от файловете за синхронизиране на съдържание. Postmeta и termmeta се разрешават чрез meta.include; meta.exclude винаги има предимство.
Предупреждение
Приемайте
meta.includeза граница на комита. Синхронизираните файлове трябва да се намират в git, затова не включвайте ключове със секрети, токени, идентификационни данни или лична информация.wp bs content statusпоказва предупредителни редове, когато разрешен мета ключ изглежда чувствителен.
content.id се съхранява в синхронизираните обекти като _blockstudio_content_set. Проверки за изчистване и собственост се ограничават до тази стойност, така че един набор от съдържание не може да изтрие съдържанието на друг.
Публикациите, управлявани от синхронизирането на страници, са изключени по подразбиране. Ако includePageSyncManaged е активирано, синхронизирането на съдържание може да синхронизира конфигурираните им метаданни, но синхронизирането на страници продължава да управлява техния post_content.
Тези проекции съдържат "bodyOwner": "page-sync". Pull отчита записа на JSON като съдържащ само метаданни и добавя ред за тялото skipped, вместо да представя публикацията като такава с празно тяло. Не записва и не изтрива съседен файл .html. Съществуващо копие за преглед се запазва и push го игнорира. Същите съобщения за собственост се включват в изхода за пробно изпълнение.
В друга среда първо стартирайте Page Sync. Проекция с bodyOwner: "page-sync" трябва да сочи към съществуваща публикация, управлявана от Page Sync; push отказва да създаде празен заместител или да приложи копието за преглед на съдържанието на тази публикация. Проекциите без маркера от по-стари версии продължават да се поддържат.
Авторите се игнорират по подразбиране, тъй като потребителите не се синхронизират. Задайте authors: "login", за да съхранявате потребителското име за вход на автора във файловете на публикациите и при качване да свързвате това име със съществуващ потребител. Липсващите потребители са грешка при предварителната проверка; синхронизирането на съдържание не създава потребители.
Команди
wp bs content pull [--post-type=<type>] [--taxonomy=<taxonomy>] [--dry-run]
wp bs content push [--dry-run] [--prune] [--yes]
wp bs content status
pull извлича съдържанието от базата данни във файлове. Задава _blockstudio_content_uid на публикациите в обхвата, които все още нямат такава стойност, и отчита остарелите файлове, чийто източник в базата данни вече не съществува. Остарелите файлове не се изтриват при изтегляне.
push прилага файловете към текущата база данни. Проверява плана преди запис и блокира неразрешените декларирани препратки, конфликтите на идентификатори в URL адреса, заключените обекти и липсващите типове публикации.
status сравнява файловете с базата данни и отчита състоянието на всеки обект като unchanged, would-update, missing-db, conflict, locked или orphaned. Освен това предупреждава за разрешени ключове за метаданни, които изглеждат като секрети, преди стойностите им да бъдат записани в хранилище, както и за числови идентификатори в телата на маркировката на блокове, тъй като синхронизирането на съдържание не пренаписва идентификатори във файлове .html.
Използвайте --dry-run, за да прегледате изтегляне или качване, без да записвате промени. Използвайте push --prune --yes, за да премахнете обекти от базата данни, притежавани от набора от съдържание, които вече не съществуват във файловете.
Безопасност при грешки
push анализира и валидира целия план на източника, преди да записва или
премахва. Неправилно форматиран JSON, неразрешени декларирани препратки, невалидна собственост и
други грешки при предварителната проверка блокират разрушителната фаза. Премахването остава ограничено
до конфигурираните типове публикации, таксономии и content.id.
pull записва всеки проектиран файл, преди да отбележи съответния обект като синхронизиран. Грешка при запис във файловата система се връща като ред с грешка и не актуализира
съхраненото състояние на синхронизация за този обект.
Обработката на прикачените файлове следва content.media. При "manifest" UID на посочените
прикачени файлове трябва да съществуват в целевата среда. При "none" декларираните
препратки към прикачени файлове умишлено се премахват от преносимия изход,
вместо да се запазват специфичните за средата ID.
Файлове
Content Sync записва файлове в конфигурираната content.path:
content/
posts/
team_member/
jane.9b1c0e6e.json
jane.9b1c0e6e.html
terms/
category/
leadership.5e900000.json
media/
manifest.json
Файловете за публикации .json съдържат идентичност, полета на публикацията, връзки с термини, декларирани метаданни и кодирането на метаданните. Съседният файл .html съхранява post_content като сурова блокова маркировка и се пропуска, когато съдържанието е празно. Файловете за термини .json съдържат идентичност, таксономия, кратко име, име, описание, UID на родителя, декларирани метаданни на термина и кодиране на метаданните.
Другият случай без файл .html е тяло, управлявано от Page Sync, разпознавано по bodyOwner по-горе. При обикновени публикации, чието тяло остане празно, pull премахва стария файл на тялото и го посочва в отделен ред за тялото 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"
}
}
Съхраненото състояние на синхронизация е:
| Ключ на метаданните | Предназначение |
|---|---|
_blockstudio_content_uid |
Преносима идентичност на съдържанието |
_blockstudio_content_set |
Пространство от имена на набора от съдържание от content.id |
_blockstudio_content_source |
Път до изходния файл спрямо темата |
_blockstudio_content_fingerprint |
Последен синхронизиран отпечатък на файл/база данни |
_blockstudio_content_locked |
Истинностна стойност предотвратява презаписването на обекта при изпращане |
Препратки
Content Sync никога не предполага, че цяло число е ID. Препратките се пренаписват само когато са конфигурирани в meta.references.
{
"meta": {
"references": {
"_related_posts": { "kind": "post", "path": "*" },
"_topic": { "kind": "term" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
}
}
При изтегляне локалните ID по тези пътища стават преносими UID. При изпращане UID се преобразуват обратно в локални ID в текущата база данни.
Родителите на публикации, родителите на термини и връзките между публикации и термини са структурни препратки, управлявани от Content Sync, и автоматично се съхраняват като UID. Конфигурираните таксономии се записват във файловете на публикациите дори когато са празни; празен масив изчиства връзките към тази таксономия при изпращане.
Препратките към прикачени файлове се валидират, но файловете не се импортират. При media: "manifest" посочените прикачени файлове се изброяват в content/media/manifest.json; при изпращане се изисква UID на посочения прикачен файл да съществува локално. При media: "none" декларираните препратки към прикачени файлове се пропускат от преносимите файлове. Тъй като пропуснат ключ не се прилага при изпращане, съществуваща публикация в целевата среда запазва текущите си метаданни за прикачени файлове.
Работен процес за преносимост
- Регистрирайте целевия тип публикация във всяка среда.
- Конфигурирайте
content.postTypes,meta.includeи всички декларирани препратки. - Изпълнете
wp bs content pullв средата източник. - Предайте генерираните файлове в хранилището.
- Изпълнете
wp bs content pushв целевата среда. - Изпълнете
wp bs content status, за да проверите дали базата данни съответства на файловете.
Файловете са източникът на истината за push. Базата данни се записва обратно във файлове с pull.
Обхват
Content Sync поддържа:
- публикации от разрешени типове публикации
- разрешени метаданни на публикации
- термини от разрешени регистрирани таксономии
- разрешени метаданни на термини
- връзки между публикации и термини
- декларирани препратки
post,attachmentиterm - преносими UID на публикации и термини и собственост на набора от съдържание
- изключване на Page Sync по подразбиране
- манифест на прикачените файлове и предварителна проверка
- обработка на
pull,push,status,--dry-run,--pruneи заключени обекти
Не се поддържат запис на дефиниции на таксономии, копиране на двоични медийни файлове и пренаписване на ID в блокова маркировка.