Liigu sisu juurde

Sisu sünkroonimine

Blockstudio põhineb failikesksel töövoo mudelil: plokid, väljad, mallid, varad, mustrid ja failipõhised lehed võivad kõik asuda teie projektis. Content Sync laiendab seda mudelit valitud WordPress andmebaasisisule meeskondade jaoks, kes soovivad ka kureeritud postitusi, termineid, seoseid ja deklareeritud metaandmeid git.

See on WP-CLI töövoog, mitte andmebaasi reaalajas replikeerimine. Tõmbamisel teisendab sisu sünkroonimine lubatud postitused, postmeta, terminid, termmeta ja postiterminite seosed sinu teemas teisaldatavateks failideks. Lükamisel rakendab see need failid teises keskkonnas, kasutades stabiilseid UID-sid ja kirjutades ümber ainult viited, mille oled selgesõnaliselt deklareerinud.

Märkus

Sisu sünkroonimine toimub nõudmisel. See ei käivitu iga administraatoripäringu korral. Käsud tagastavad vahele jäetud rea, kuni content.enabled on true.

Millal sisu sünkroonimist kasutada

Kasuta sisu sünkroonimist sisukogumite jaoks, mida on oluline versioonida, üle vaadata ja eri keskkondade vahel liigutada:

  • struktureeritud sisu, näiteks meeskonnaliikmed, asukohad, juhtumiuuringud, tooted, dokumentatsioonikirjed või kampaanialehed
  • taksonoomiad ja seosed, mis kuuluvad nende sisukogumite juurde
  • lubatud metaandmed, mida on ohutu sisse kanda ja mis vajavad püsiviiteid
  • väikesed ja keskmise suurusega sisukogumid, mille faile on git veel praktiline üle vaadata

Rusikareeglina sobib sisu sünkroonimine kümnete või sadade ridade jaoks ning võib ulatuda mõne tuhande reani, kui andmed on struktureeritud, muutuvad harva ja jaotatud fokusseeritud postitustüüpide vahel. See pole mõeldud kogu tootmisandmebaasi, tiheda liiklusega toimetussisu, logide, tellimuste, analüütika, vormiedastuste, seansside ega muude suuremahuliste või sageli muutuvate andmete peegeldamiseks. Kui loodud faile on raske üle vaadata, lükkeid on liiga aeganõudev mõtestada või enamik ridu muutub väljaspool juurutustöövoogu, kasuta selle asemel andmebaasi varukoopia, migratsiooni või importimise ja eksportimise tööriista.

Meediafailide binaarandmeid ei kopeerita. Manifetis saab salvestada manuste viiteid ja neid valideerida, kuid failid peavad sihtkeskkonnas juba olemas olema.

Konfiguratsioon

Luba sisu sünkroonimine asukohas 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 on lubatud kirjete loend. Tühi loend tähendab, et sisu sünkroonimine ei puuduta postitusi. taxonomies on registreeritud taksonoomiate loend, mille termineid ja postituste seoseid sünkroonitakse. Blockstudio ei registreeri sisu sünkroonimise failidest taksonoomiamääratlusi. Postmeta ja termmeta lubatud võtmed määratakse loendis meta.include; meta.exclude jääb alati peale.

Hoiatus

Käsitle meta.include sissekandmise piirina. Sünkroonitud failid on mõeldud asuma git, seega ära lisa võtmeid, mis sisaldavad saladusi, tokeneid, mandaate või isikuandmeid. wp bs content status annab hoiatuse, kui lubatud metaandmete võti tundub tundlik.

content.id salvestatakse sünkroonitud olemitele kujul _blockstudio_content_set. Kärpimise ja omandi kontrollid kehtivad ainult selle väärtuse piires, nii et üks sisukogum ei saa teise kogumi sisu kustutada.

Page Synci hallatavad postitused jäetakse vaikimisi välja. Kui includePageSyncManaged on lubatud, saab sisu sünkroonimine nende seadistatud metaandmeid sünkroonida, kuid Page Sync haldab endiselt nende post_content väärtust.

Need projektsioonid sisaldavad "bodyOwner": "page-sync". Pull märgib JSON kirjutamise ainult metaandmeid sisaldavaks ja lisab skipped keharida, selle asemel et esitada postitust tühja sisuga. See ei kirjuta ega kustuta kaasfaili .html. Olemasolev ülevaatuskoopia säilitatakse ja push eirab seda. Samad omandisõnumid lisatakse kuivkäivituse väljundisse.

Teises keskkonnas käivitage esmalt Page Sync. Projektsioon, millel on bodyOwner: "page-sync", peab viitama olemasolevale Page Synci hallatavale postitusele; push keeldub looma tühja asendust või rakendamast selle sisu ülevaatuskoopiat. Vanemate versioonide projektsioonid, millel marker puudub, jäävad toetatuks.

Autoreid vaikimisi eiratakse, sest kasutajaid ei sünkroonita. Määra authors: "login", et salvestada autori kasutajanimi postitusfailidesse ning leida see nimi lükkamisel olemasoleva kasutaja järgi. Puuduvate kasutajate korral ilmneb eelkontrolli viga; sisu sünkroonimine kasutajaid ei loo.

Käsud

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

pull salvestab andmebaasi sisu failidesse. See määrab ulatusse kuuluvatele postitustele _blockstudio_content_uid, kui neil seda veel pole, ja teatab aegunud failidest, mille andmebaasiallikat enam ei eksisteeri. Tõmbamine aegunud faile ei kustuta.

push rakendab failid praeguses andmebaasis. See valideerib enne kirjutamist plaani ja blokeerib lahendamata deklareeritud viited, URL-nimekonfliktid, lukustatud olemid ja puuduvad postitustüübid.

status võrdleb faile andmebaasiga ning teatab iga olemi olekuks unchanged, would-update, missing-db, conflict, locked või orphaned. Samuti hoiatab see enne väärtuste salvestamist lubatud metaandmete võtmete eest, mis näivad saladustena, ning plokimärgistuse kehas olevate arvuliste ID-de eest, sest sisu sünkroonimine ei kirjuta faile .html ümber.

Kasuta käsku --dry-run tõmbamise või lükkamise uurimiseks ilma midagi kirjutamata. Kasuta käsku push --prune --yes sisukogumile kuuluvate andmebaasi olemite eemaldamiseks, kui neid failides enam pole.

Tõrketaluvus

push analüüsib ja valideerib kogu lähteplaani enne kirjutamist või kärpimist. Vigane JSON, lahendamata deklareeritud viited, kehtetu omandiõigus ja muud eelkontrolli vead peatavad muudatusi tegeva etapi. Kärpimine piirdub seadistatud sisutüüpide, taksonoomiate ja content.id-ga.

pull kirjutab iga kavandatud faili enne, kui märgib üksuse sünkroonituks. Failisüsteemi kirjutamisviga tagastatakse veareana ega uuenda selle üksuse salvestatud sünkroonimisolekut.

Manuste käsitlemisel järgitakse reeglit content.media. Sättega "manifest" peavad viidatud manuste UID-d sihtkeskkonnas olemas olema. Sättega "none" eemaldatakse deklareeritud manuseviited kaasaskantavast väljundist, selle asemel et säilitada keskkonnaspetsiifilisi ID-sid.

Failid

Content Sync kirjutab failid seadistatud asukohta content.path:

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

Postituse .json failid salvestavad identiteedi, postituse väljad, termini seosed, deklareeritud metaandmed ja metaandmete kodeeringu. Kõrvalasuv fail .html salvestab post_content toore plokimärgistusena ja jäetakse välja, kui sisu on tühi. Termini .json failid salvestavad identiteedi, taksonoomia, püsilingi, nime, kirjelduse, ülem-UID, deklareeritud termmetaandmed ja metaandmete kodeeringu.

Teine juht, kus .html fail puudub, on Page Synci hallatav sisu, mille tunneb ära ülal oleva bodyOwner järgi. Tavaliste postituste puhul, mille sisu muutub tühjaks, eemaldab pull vana sisufaili ja nimetab selle eraldi deleted sisureal.

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

Salvestatud sünkroonimisolek on järgmine:

Meta võti Eesmärk
_blockstudio_content_uid Kaasaskantava sisu identiteet
_blockstudio_content_set Sisutekomplekti nimeruum allikast content.id
_blockstudio_content_source Teemaga seotud lähtefaili tee
_blockstudio_content_fingerprint Viimati sünkroonitud faili/andmebaasi sõrmejälg
_blockstudio_content_locked Tõene väärtus takistab push-toimingul üksuse ülekirjutamist

Viited

Content Sync ei arva kunagi, et täisarv on ID. Viited kirjutatakse ümber ainult siis, kui need on seadistatud kohas meta.references.

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

Tõmbamisel muutuvad kohalike ID-de asemel neis asukohtades kaasaskantavad UID-d. Lükamisel lahendatakse UID-d praeguses andmebaasis tagasi kohalikeks ID-deks.

Postituse ülemad, terminite ülemad ja postituse ning termini vahelised seosed on Content Synci hallatavad struktuuriviited ning salvestatakse automaatselt UID-dena. Seadistatud taksonoomiad kirjutatakse postituse failidesse ka siis, kui need on tühjad; tühi massiiv tühjendab lükkamisel selle taksonoomia seosed.

Manuste viiteid valideeritakse, mitte ei impordita. Sättega media: "manifest" loetletakse viidatud manused kohas content/media/manifest.json; lükkamisel peab viidatud manuse UID olema kohalikus keskkonnas olemas. Sättega media: "none" jäetakse deklareeritud manuseviited kaasaskantavatest failidest välja. Kuna väljajäetud võtit lükkamisel ei rakendata, säilivad olemasoleva sihtpostituse praegused manuse metaandmed.

Kaasaskantavuse töövoog

  1. Registreerige sihtsisutüüp igas keskkonnas.
  2. Seadistage content.postTypes, meta.include ja kõik deklareeritud viited.
  3. Käivitage lähtekeskkonnas wp bs content pull.
  4. Kinnitage loodud failid versioonihaldusse.
  5. Käivitage sihtkeskkonnas wp bs content push.
  6. Käivitage wp bs content status, et kontrollida, kas andmebaas vastab failidele.

Failid on push tõeallikas. Andmebaasi sisu salvestatakse failidesse tagasi käsuga pull.

Ulatus

Content Sync toetab järgmist:

  • lubatud loendis olevate sisutüüpide postitused
  • lubatud loendis olev postitusmeta
  • lubatud loendis olevate registreeritud taksonoomiate terminid
  • lubatud loendis olev terminmeta
  • postituse ja termini vahelised seosed
  • deklareeritud viited post, attachment ja term
  • kaasaskantavad postituse ja termini UID-d ning sisuteksti omandiõigus
  • Page Synci välistamine vaikimisi
  • manuste manifest ja eelkontroll
  • pull, push, status, --dry-run, --prune ning lukustatud üksuste käsitlemine

Taksonoomia määratluste hõivamine, meediafailide binaarandmete kopeerimine ja plokimärgistuses ID-de ümberkirjutamine pole toetatud.