Sincronizarea conținutului
Blockstudio este construit în jurul unui flux de lucru bazat pe fișiere: blocurile, câmpurile, șabloanele, resursele, modelele și paginile bazate pe fișiere pot fi toate în proiectul dvs. Sincronizarea conținutului extinde acest model la conținutul selectat din baza de date WordPress pentru echipele care doresc, de asemenea, ca articolele, termenii, relațiile și metadatele declarate, gestionate cu grijă, să se afle în git.
Este un flux de lucru WP-CLI, nu o replicare live a bazei de date. La preluare, Sincronizarea conținutului proiectează articolele, postmeta, termenii, termmeta și relațiile articol-termen permise în fișiere portabile din tema dvs. La publicare, aplică acele fișiere într-un alt mediu, folosind UID-uri stabile și rescriind numai referințele pe care le declarați explicit.
Notă
Sincronizarea conținutului se efectuează la cerere. Nu rulează la fiecare solicitare de administrare. Comenzile returnează un rând omis până când
content.enabledestetrue.
Când să folosiți sincronizarea conținutului
Folosiți Sincronizarea conținutului pentru seturi de conținut importante pentru controlul versiunilor, revizuire și transferul între medii:
- conținut structurat, precum membri ai echipei, locații, studii de caz, produse, intrări de documentație sau pagini de campanie
- taxonomii și relații asociate acelor seturi de conținut
- metadate permise, sigure pentru includerea în commit și care necesită referințe stabile
- seturi de conținut mici sau medii, pentru care revizuirea fișierelor în git rămâne practică
Ca regulă generală, Sincronizarea conținutului este potrivită pentru zeci sau sute de rânduri și poate funcționa și pentru câteva mii, dacă datele sunt structurate, se schimbă rar și sunt împărțite în tipuri de articole bine delimitate. Nu este concepută pentru a oglindi o întreagă bază de date de producție, conținut editorial cu trafic intens, jurnale, comenzi, analize, trimiteri de formulare, sesiuni sau alte date cu volum mare ori care se schimbă frecvent. Dacă fișierele generate devin greu de revizuit din cauza zgomotului, publicările durează prea mult de analizat sau majoritatea rândurilor se schimbă în afara fluxului de implementare, folosiți în schimb un instrument de backup, migrare sau import/export al bazei de date.
Fișierele binare media nu sunt copiate. Referințele la atașamente pot fi înregistrate într-un manifest și validate, dar fișierele propriu-zise trebuie să existe în mediul de destinație.
Configurare
Activați Sincronizarea conținutului în 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 este o listă de permisiuni. Dacă este goală, Sincronizarea conținutului nu modifică articolele. taxonomies este o listă de taxonomii deja înregistrate ale căror termeni și relații cu articolele ar trebui sincronizate. Blockstudio nu înregistrează definiții de taxonomii din fișierele Sincronizării conținutului. Postmeta și termmeta sunt permise prin meta.include; meta.exclude are întotdeauna prioritate.
Avertisment
Tratați
meta.includeca pe o limită pentru commit. Fișierele sincronizate trebuie păstrate în git, așa că nu includeți chei care conțin secrete, tokenuri, acreditări sau informații personale de identificare.wp bs content statusraportează rânduri de avertizare când o cheie meta permisă pare să conțină informații sensibile.
content.id este stocat pe entitățile sincronizate ca _blockstudio_content_set. Verificările de curățare și de proprietate sunt limitate la acea valoare, astfel încât un set de conținut nu poate șterge conținutul altui set.
Articolele gestionate de Sincronizarea paginilor sunt excluse implicit. Dacă includePageSyncManaged este activat, Sincronizarea conținutului le poate sincroniza metadatele configurate, dar Sincronizarea paginilor rămâne responsabilă pentru post_content.
Aceste proiecții conțin "bodyOwner": "page-sync". Comanda Pull raportează scrierea JSON ca având doar metadate și adaugă un rând pentru corpul skipped, în loc să prezinte articolul ca având un corp gol. Nu scrie și nu șterge un fișier .html asociat. O copie existentă pentru revizuire este păstrată și ignorată de push. Aceleași mesaje privind proprietatea sunt incluse în rezultatul execuției de probă.
Într-un alt mediu, rulați mai întâi Page Sync. O proiecție cu bodyOwner: "page-sync" trebuie să facă referire la o postare existentă gestionată de Page Sync; push refuză să creeze un substitut gol sau să aplice copia de revizie a corpului respectiv. Proiecțiile fără marker, din versiuni mai vechi, sunt în continuare acceptate.
Autorii sunt ignorați implicit deoarece utilizatorii nu sunt sincronizați. Setați authors: "login" pentru a stoca numele de autentificare al autorului în fișierele articolelor și pentru a asocia acel nume de autentificare unui utilizator existent la publicare. Utilizatorii inexistenți provoacă o eroare la verificarea prealabilă; Sincronizarea conținutului nu creează utilizatori.
Comenzi
wp bs content pull [--post-type=<type>] [--taxonomy=<taxonomy>] [--dry-run]
wp bs content push [--dry-run] [--prune] [--yes]
wp bs content status
pull capturează conținutul bazei de date în fișiere. Atribuie _blockstudio_content_uid articolelor vizate care nu au încă unul și raportează fișierele învechite a căror sursă din baza de date nu mai există. Fișierele învechite nu sunt șterse la preluare.
push aplică fișierele în baza de date curentă. Validează planul înainte de scriere și blochează referințele declarate nerezolvate, conflictele de slug, entitățile blocate și tipurile de articole lipsă.
status compară fișierele cu baza de date și raportează fiecare entitate ca fiind unchanged, would-update, missing-db, conflict, locked sau orphaned. Avertizează și asupra cheilor meta permise care par să conțină secrete, înainte ca valorile să fie incluse în commit, precum și asupra ID-urilor numerice din corpurile marcajului blocurilor, deoarece Sincronizarea conținutului nu rescrie ID-urile din fișierele .html.
Folosiți --dry-run pentru a inspecta o preluare sau o publicare fără a scrie. Folosiți push --prune --yes pentru a elimina entitățile din baza de date deținute de setul de conținut care nu mai există în fișiere.
Siguranța în caz de eșec
push analizează și validează întregul plan sursă înainte de a scrie sau
curăța. Datele JSON malformate, referințele declarate nerezolvate, dreptul de proprietate invalid și
alte erori la verificarea prealabilă blochează etapa distructivă. Curățarea rămâne limitată
la tipurile de articole, taxonomiile și content.id configurate.
pull scrie fiecare fișier proiectat înainte de a înregistra entitatea ca sincronizată. Eșecul scrierii în sistemul de fișiere este returnat ca rând de eroare și nu actualizează starea de sincronizare stocată pentru acea entitate.
Gestionarea atașamentelor urmează content.media. Cu "manifest", UID-urile atașamentelor referențiate trebuie să existe în mediul țintă. Cu "none", referințele la atașamente declarate sunt eliminate intenționat din rezultatul portabil, în loc să fie păstrate ID-urile specifice mediului.
Fișiere
Content Sync scrie fișiere în content.path configurat:
content/
posts/
team_member/
jane.9b1c0e6e.json
jane.9b1c0e6e.html
terms/
category/
leadership.5e900000.json
media/
manifest.json
Fișierele .json pentru articole stochează identitatea, câmpurile articolului, relațiile cu termenii, metadatele declarate și codificarea metadatelor. Fișierul alăturat .html stochează post_content ca marcaj brut de bloc și este omis când conținutul este gol. Fișierele .json pentru termeni stochează identitatea, taxonomia, slug-ul, numele, descrierea, UID-ul părintelui, metadatele termenului declarate și codificarea metadatelor.
Celălalt caz, fără fișierul .html, este un corp gestionat de Page Sync, identificat mai sus prin bodyOwner. Pentru postările obișnuite al căror corp devine gol, pull elimină vechiul fișier al corpului și îl menționează într-un rând separat deleted pentru corp.
{
"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"
}
}
Starea sincronizării stocată este:
| Cheie meta | Scop |
|---|---|
_blockstudio_content_uid |
Identitate portabilă a conținutului |
_blockstudio_content_set |
Spațiu de nume al setului de conținut din content.id |
_blockstudio_content_source |
Calea fișierului relativă la temă |
_blockstudio_content_fingerprint |
Amprenta ultimei sincronizări a fișierului/bazei de date |
_blockstudio_content_locked |
O valoare truthy împiedică push să suprascrie entitatea |
Referințe
Content Sync nu presupune niciodată că un număr întreg este un ID. Referințele sunt rescrise numai când sunt configurate în meta.references.
{
"meta": {
"references": {
"_related_posts": { "kind": "post", "path": "*" },
"_topic": { "kind": "term" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
}
}
La pull, ID-urile locale de la acele căi devin UID-uri portabile. La push, UID-urile sunt rezolvate înapoi la ID-uri locale în baza de date curentă.
Părinții articolelor, părinții termenilor și relațiile articol-termen sunt referințe structurale gestionate de Content Sync și sunt stocate automat ca UID-uri. Taxonomiile configurate sunt scrise în fișierele articolelor chiar și când sunt goale; un tablou gol șterge relațiile acelei taxonomii la push.
Referințele la atașamente sunt validate, nu importate. Cu media: "manifest", atașamentele referențiate sunt listate în content/media/manifest.json; push necesită ca UID-ul atașamentului referențiat să existe local. Cu media: "none", referințele la atașamente declarate sunt omise din fișierele portabile. Deoarece o cheie omisă nu este aplicată la push, un articol existent în țintă își păstrează metadatele actuale pentru atașamente.
Flux de lucru pentru portabilitate
- Înregistrați tipul de articol țintă în fiecare mediu.
- Configurați
content.postTypes,meta.includeși toate referințele declarate. - Rulați
wp bs content pullîn mediul sursă. - Faceți commit la fișierele generate.
- Rulați
wp bs content pushîn mediul țintă. - Rulați
wp bs content statuspentru a verifica dacă baza de date corespunde fișierelor.
Fișierele sunt sursa de adevăr pentru push. Baza de date este capturată înapoi în fișiere cu pull.
Domeniu de aplicare
Content Sync acceptă:
- articole din tipurile de articole permise
- metadatele articolelor permise
- termeni din taxonomiile înregistrate permise
- metadatele termenilor permise
- relații articol-termen
- referințe
post,attachmentșitermdeclarate - UID-uri portabile pentru articole și termeni și asocierea la setul de conținut
- excluderea Page Sync în mod implicit
- manifestul atașamentelor și validarea prealabilă
- gestionarea
pull,push,status,--dry-run,--pruneși a entităților blocate
Capturarea definițiilor taxonomiilor, copierea fișierelor binare media și rescrierea ID-urilor din marcajul blocurilor nu sunt acceptate.