Синхронізація вмісту
Blockstudio побудований навколо файлового процесу: блоки, поля, шаблони, ресурси, патерни й сторінки у вигляді файлів можуть зберігатися у вашому проєкті. Синхронізація вмісту поширює цю модель на вибраний вміст бази даних 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. Перевірки очищення й належності обмежені цим значенням, тому один набір вмісту не може видалити вміст іншого.
Керовані публікації Page Sync типово виключені. Якщо ввімкнути includePageSyncManaged, синхронізація вмісту може синхронізувати налаштовані для них метадані, але їхній post_content і далі належить Page Sync.
Ці проєкції містять "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 застосовує файли до поточної бази даних. Вона перевіряє план перед записом і блокує невирішені оголошені посилання, конфлікти slug, заблоковані сутності та відсутні типи записів.
status порівнює файли з базою даних і повідомляє статус кожної сутності: unchanged, would-update, missing-db, conflict, locked або orphaned. Вона також попереджає про ключі метаданих зі списку дозволених, схожі на секрети, перш ніж їх додати до коміту, а також про числові ID в тілах розмітки блоків, оскільки синхронізація вмісту не переписує ID у файлах .html.
Використовуйте --dry-run, щоб перевірити отримання чи надсилання вмісту без запису. Використовуйте push --prune --yes, щоб видалити із бази даних сутності, якими володіє набір вмісту, але яких більше немає у файлах.
Захист від збоїв
push аналізує й перевіряє весь план джерела перед записом або
очищенням. Некоректний JSON, невирішені оголошені посилання, недійсна належність та
інші помилки попередньої перевірки блокують деструктивний етап. Очищення обмежене
налаштованими типами записів, таксономіями та content.id.
pull записує кожен спроєктований файл, перш ніж позначити відповідну сутність як синхронізовану. Помилка запису у файлову систему повертається як рядок помилки й не оновлює збережений стан синхронізації цієї сутності.
Обробка вкладень відповідає content.media. За умови "manifest" UID вкладень, на які є посилання, мають існувати в цільовому середовищі. За умови "none" оголошені посилання на вкладення навмисно вилучаються з переносного виводу, а не зберігаються як ідентифікатори, специфічні для середовища.
Файли
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 |
Істинне значення забороняє push перезаписувати сутність |
Посилання
Content Sync ніколи не вважає ціле число ідентифікатором. Посилання переписуються лише тоді, коли їх налаштовано в meta.references.
{
"meta": {
"references": {
"_related_posts": { "kind": "post", "path": "*" },
"_topic": { "kind": "term" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
}
}
Під час pull локальні ідентифікатори за цими шляхами стають переносними UID. Під час push UID знову перетворюються на локальні ідентифікатори в поточній базі даних.
Батьківські записи, батьківські терміни та зв’язки записів із термінами — це структурні посилання, якими керує Content Sync; вони автоматично зберігаються як UID. Налаштовані таксономії записуються у файли записів, навіть якщо вони порожні; порожній масив очищає зв’язки цієї таксономії під час push.
Посилання на вкладення перевіряються, але вкладення не імпортуються. За умови media: "manifest" вкладення, на які є посилання, перелічуються в content/media/manifest.json; для push потрібна локальна наявність UID вкладення, на яке є посилання. За умови media: "none" оголошені посилання на вкладення не включаються до переносних файлів. Оскільки пропущений ключ не застосовується під час push, наявні метадані вкладень цільового запису залишаються без змін.
Процес перенесення
- Зареєструйте тип цільового запису в кожному середовищі.
- Налаштуйте
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і заблокованих сутностей
Захоплення визначень таксономій, копіювання двійкових файлів медіа та переписування ідентифікаторів у розмітці блоків не підтримуються.