Preskoči na vsebino

Sinhronizacija vsebine

Blockstudio temelji na poteku dela, ki daje prednost datotekam: bloki, polja, predloge, sredstva, vzorci in strani na podlagi datotek so lahko del vašega projekta. Sinhronizacija vsebine ta model razširi na izbrano vsebino iz zbirke podatkov WordPress za ekipe, ki želijo v git vključiti tudi skrbno izbrane objave, izraze, relacije in izrecno določene metapodatke.

Gre za potek dela WP-CLI, ne za sprotno podvajanje zbirke podatkov. Pri prevzemu Sinhronizacija vsebine prenese odobrene objave, postmeta, izraze, termmeta in relacije med objavami ter izrazi v prenosljive datoteke v vaši temi. Pri pošiljanju te datoteke uporabi v drugem okolju, pri čemer uporabi stabilne identifikatorje UID in prepiše samo reference, ki jih izrecno določite.

Opomba

Sinhronizacija vsebine se zažene na zahtevo. Ne izvaja se ob vsaki skrbniški zahtevi. Ukazi vrnejo vrstico s stanjem preskočeno, dokler content.enabled ni true.

Kdaj uporabiti sinhronizacijo vsebine

Sinhronizacijo vsebine uporabite za vsebinske sklope, ki jih je pomembno dodati v sistem za nadzor različic, pregledati in prenesti med okolji:

  • strukturirana vsebina, kot so člani ekipe, lokacije, študije primerov, izdelki, dokumentacijski zapisi ali strani kampanj
  • taksonomije in relacije, ki sodijo k tem vsebinskim sklopom
  • odobreni metapodatki, ki jih je varno objaviti v sistemu za nadzor različic in za katere so potrebne stabilne reference
  • majhni do srednje veliki vsebinski sklopi, pri katerih je pregledovanje datotek v git še praktično

Splošno pravilo je, da Sinhronizacija vsebine dobro deluje z desetinami ali stotinami vrstic, pri strukturiranih podatkih z malo spremembami, razdeljenih na osredotočene tipe objav, pa tudi z nekaj tisoč. Ni namenjena zrcaljenju celotne produkcijske zbirke podatkov, uredniške vsebine z veliko prometa, dnevnikov, naročil, analitike, oddaj obrazcev, sej ali drugih podatkov z velikim obsegom ali pogostimi spremembami. Če je ustvarjene datoteke težko pregledovati, če je razmislek o potisnih posodobitvah prezahteven ali če se večina vrstic spreminja zunaj vašega postopka uvajanja, raje uporabite varnostno kopijo zbirke podatkov, migracijo ali orodje za uvoz in izvoz.

Binarne predstavnostne datoteke se ne kopirajo. Sklice na priloge lahko zabeležite v manifestu in jih preverite, vendar morajo datoteke obstajati v ciljnem okolju.

Konfiguracija

Omogočite sinhronizacijo vsebine v blockstudio.json:

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 dovoljenih vrednosti. Če je prazen, se Sinhronizacija vsebine ne dotakne objav. taxonomies je seznam že registriranih taksonomij, katerih izrazi in relacije z objavami naj se sinhronizirajo. Blockstudio iz datotek Sinhronizacije vsebine ne registrira definicij taksonomij. Metapodatki objav in izrazov so vključeni na seznam dovoljenih prek meta.include; meta.exclude ima vedno prednost.

Opozorilo

meta.include obravnavajte kot mejo za objavo v sistemu za nadzor različic. Sinhronizirane datoteke so namenjene shranjevanju v git, zato ne vključujte ključev s skrivnostmi, žetoni, poverilnicami ali osebnimi podatki. wp bs content status poroča opozorilne vrstice, kadar je videti, da ključ metapodatka na seznamu dovoljenih vsebuje občutljive podatke.

content.id je v sinhroniziranih entitetah shranjen kot _blockstudio_content_set. Preverjanje čiščenja in lastništva se omeji na to vrednost, zato en vsebinski sklop ne more izbrisati vsebine drugega sklopa.

Objave, ki jih upravlja sinhronizacija strani, so privzeto izključene. Če omogočite includePageSyncManaged, lahko Sinhronizacija vsebine sinhronizira njihove nastavljene metapodatke, vendar je za njihove post_content še vedno pristojna sinhronizacija strani.

Te projekcije vsebujejo "bodyOwner": "page-sync". Prenos poroča o zapisu JSON kot o zapisu, ki vsebuje samo metapodatke, in doda vrstico telesa skipped, namesto da bi objavo prikazal, kot da ima prazno telo. Ne zapiše ali izbriše sosednje datoteke .html. Obstoječa kopija za pregled se ohrani in prezre pri pošiljanju. Ista sporočila o lastništvu so vključena v izhodni preizkusni zagon.

V drugem okolju najprej zaženite Page Sync. Projekcija z bodyOwner: "page-sync" se mora sklicevati na obstoječo objavo, ki jo upravlja Page Sync; push zavrne ustvarjanje praznega nadomestka ali uporabo pregledane kopije vsebine. Projekcije brez označevalnika iz starejših različic so še vedno podprte.

Avtorji so privzeto prezrti, ker se uporabniki ne sinhronizirajo. Nastavite authors: "login", da se uporabniško ime avtorja shrani v datoteke objav in nato pri pošiljanju poveže z obstoječim uporabnikom. Če uporabnik manjka, preverjanje pred izvedbo vrne napako; Sinhronizacija vsebine uporabnikov ne ustvari.

Ukazi

Lupina
wp bs content pull [--post-type=<type>] [--taxonomy=<taxonomy>] [--dry-run]
wp bs content push [--dry-run] [--prune] [--yes]
wp bs content status

pull zajame vsebino zbirke podatkov v datoteke. Objavam v obsegu dodeli _blockstudio_content_uid, če ga še nimajo, in poroča o zastarelih datotekah, katerih vir v zbirki podatkov ne obstaja več. Zastarele datoteke se pri prevzemu ne izbrišejo.

push uporabi datoteke v trenutni zbirki podatkov. Pred pisanjem preveri načrt in blokira nerešene deklarirane reference, spore med polžki, zaklenjene entitete in manjkajoče tipe objav.

status primerja datoteke z zbirko podatkov in za vsako entiteto navede stanje unchanged, would-update, missing-db, conflict, locked ali orphaned. Opozori tudi na ključe metapodatkov na seznamu dovoljenih, ki so videti kot skrivnosti, še preden so te vrednosti objavljene v sistemu za nadzor različic, ter na številske ID-je v telesih označevalne kode blokov, saj Sinhronizacija vsebine ne prepisuje ID-jev v datotekah .html.

Z --dry-run preglejte prevzem ali pošiljanje brez zapisovanja. Z push --prune --yes odstranite entitete zbirke podatkov, ki so v lasti vsebinskega sklopa, vendar jih v datotekah ni več.

Varno obravnavanje napak

push razčleni in preveri celoten izvorni načrt, preden kar koli zapiše ali odstrani. Napačno oblikovan JSON, nerešene deklarirane reference, neveljavno lastništvo in druge napake pri preverjanju pred izvedbo blokirajo destruktivno fazo. Odstranjevanje ostane omejeno na nastavljene tipe objav, taksonomije in content.id.

pull zapiše vsako preneseno datoteko, preden entiteto označi kot sinhronizirano. Če zapis v datotečni sistem ne uspe, se vrne vrstica z napako, shranjeno stanje sinhronizacije za to entiteto pa se ne posodobi.

Obravnava prilog sledi content.media. Pri "manifest" morajo navedeni UID-ji prilog obstajati v ciljnem okolju. Pri "none" se deklarirane reference na priloge namerno odstranijo iz prenosnega izhoda, namesto da bi se ohranili ID-ji, specifični za okolje.

Datoteke

Content Sync zapisuje datoteke v konfigurirani content.path:

Koda
content/
  posts/
    team_member/
      jane.9b1c0e6e.json
      jane.9b1c0e6e.html
  terms/
    category/
      leadership.5e900000.json
  media/
    manifest.json

Datoteke objav .json shranjujejo identiteto, polja objave, povezave z izrazi, deklarirane metapodatke in kodiranje metapodatkov. Sestrska datoteka .html shranjuje post_content kot neobdelan označevalni zapis blokov in je izpuščena, kadar je vsebina prazna. Datoteke izrazov .json shranjujejo identiteto, taksonomijo, slug, ime, opis, UID nadrejenega elementa, deklarirane metapodatke izraza in kodiranje metapodatkov.

Drugi primer brez datoteke .html je vsebina, ki jo upravlja Page Sync in je prepoznana po bodyOwner zgoraj. Pri običajnih objavah, katerih vsebina postane prazna, pull odstrani staro datoteko z vsebino in jo navede v ločeni vrstici vsebine deleted.

JSON
{
  "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"
  }
}

Shranjeno stanje sinhronizacije je:

Ključ metapodatkov Namen
_blockstudio_content_uid Prenosna identiteta vsebine
_blockstudio_content_set Imenski prostor nabora vsebine iz content.id
_blockstudio_content_source Pot do izvorne datoteke glede na temo
_blockstudio_content_fingerprint Prstni odtis zadnje sinhronizirane datoteke/podatkovne zbirke
_blockstudio_content_locked Resnična vrednost prepreči, da bi potisna sinhronizacija prepisala entiteto

Reference

Content Sync nikoli ne predpostavi, da je celo število ID. Reference se prepišejo samo, če so konfigurirane v meta.references.

JSON
{
  "meta": {
    "references": {
      "_related_posts": { "kind": "post", "path": "*" },
      "_topic": { "kind": "term" },
      "_hero": { "kind": "attachment", "path": "image.id" }
    }
  }
}

Pri povleku lokalni ID-ji na teh poteh postanejo prenosni UID-ji. Pri potisku se UID-ji razrešijo nazaj v lokalne ID-je v trenutni podatkovni zbirki.

Nadrejene objave, nadrejeni izrazi in povezave med objavami ter izrazi so strukturne reference, ki jih upravlja Content Sync in se samodejno shranijo kot UID-ji. Konfigurirane taksonomije se zapišejo v datoteke objav tudi, kadar so prazne; prazna matrika pri potisku izbriše povezave te taksonomije.

Reference na priloge se preverijo, ne uvozijo. Pri media: "manifest" so navedene priloge prikazane v content/media/manifest.json; potisk zahteva, da referenčni UID priloge obstaja lokalno. Pri media: "none" so deklarirane reference na priloge izpuščene iz prenosnih datotek. Ker se izpuščeni ključ med potiskom ne uporabi, obstoječa ciljna objava ohrani svoje trenutne metapodatke priloge.

Potek dela za prenosljivost

  1. Registrirajte ciljno vrsto objave v vsakem okolju.
  2. Konfigurirajte content.postTypes, meta.include in vse deklarirane reference.
  3. V izvornem okolju zaženite wp bs content pull.
  4. Potrdite ustvarjene datoteke.
  5. V ciljnem okolju zaženite wp bs content push.
  6. Zaženite wp bs content status, da preverite, ali se podatkovna zbirka ujema z datotekami.

Datoteke so glavni vir resnice za push. Podatkovna zbirka se z pull znova zapiše v datoteke.

Obseg

Content Sync podpira:

  • objave z dovoljenih vrst objav
  • metapodatke objav z dovoljenega seznama
  • izraze z dovoljenih registriranih taksonomij
  • metapodatke izrazov z dovoljenega seznama
  • povezave med objavami in izrazi
  • deklarirane reference post, attachment in term
  • prenosne UID-je objav in izrazov ter lastništvo naborov vsebine
  • privzeto izključitev Page Sync
  • manifest prilog in preverjanje pred izvedbo
  • obravnavo pull, push, status, --dry-run, --prune ter zaklenjenih entitet

Zajem definicij taksonomij, kopiranje binarnih datotek predstavnosti in prepisovanje ID-jev v označevalnem zapisu blokov niso podprti.