Ugrás a tartalomhoz

Tartalomszinkronizálás

A Blockstudio fájlalapú munkafolyamatra épül: a blokkok, mezők, sablonok, erőforrások, minták és fájlalapú oldalak mind a projektben tárolhatók. A Tartalomszinkronizálás ezt a modellt terjeszti ki a kiválasztott WordPress adatbázis-tartalmakra azoknak a csapatoknak, amelyek a gondosan összeállított bejegyzéseket, kifejezéseket, kapcsolatokat és deklarált metaadatokat is szeretnék a gitben tárolni.

Ez WP-CLI munkafolyamat, nem pedig élő adatbázis-replikáció. Lekéréskor a Tartalomszinkronizálás az engedélyezőlistán szereplő bejegyzéseket, postmeta-adatokat, kifejezéseket, termmeta-adatokat és bejegyzés–kifejezés kapcsolatokat hordozható fájlokba vetíti ki a témában. Feltöltéskor ezeket a fájlokat egy másik környezetben alkalmazza, stabil UID-k használatával, és csak azokat a hivatkozásokat írja át, amelyeket kifejezetten megadsz.

Megjegyzés

A Tartalomszinkronizálás igény szerint fut. Nem indul el minden adminisztrációs kérésnél. A parancsok kihagyott sort adnak vissza, amíg a content.enabled nincs true állapotban.

Mikor használja a Tartalomszinkronizálást?

A Tartalomszinkronizálást olyan tartalomkészletekhez használja, amelyeket fontos verziókövetni, ellenőrizni és a környezetek között mozgatni:

  • strukturált tartalmakhoz, például csapattagokhoz, helyszínekhez, esettanulmányokhoz, termékekhez, dokumentációs bejegyzésekhez vagy kampányoldalakhoz
  • az ilyen tartalomkészletekhez tartozó taxonómiákhoz és kapcsolatokhoz
  • olyan engedélyezőlistán szereplő metaadatokhoz, amelyeket biztonságos véglegesíteni, és amelyeknek stabil hivatkozásokra van szükségük
  • kis és közepes méretű tartalomkészletekhez, amelyek fájljainak gitben történő ellenőrzése még gyakorlatias

Általános irányelvként a Tartalomszinkronizálás kényelmesen kezel több tucat vagy néhány száz sort, és néhány ezer sorral is megbirkózhat, ha az adatok strukturáltak, ritkán változnak, és célzott bejegyzéstípusokra vannak bontva. Nem teljes éles adatbázisok, nagy forgalmú szerkesztőségi tartalmak, naplók, rendelések, analitika, űrlapbeküldések, munkamenetek vagy más nagy mennyiségű, illetve gyakran változó adatok tükrözésére készült. Ha a létrehozott fájlokat nehéz átnézni, a feltöltések módosításait nehéz követni, vagy a sorok többsége a telepítési munkafolyamaton kívül változik, használj inkább adatbázis-mentési, migrációs vagy import/export eszközt.

A médiafájlok bináris adatai nem másolódnak. A csatolmányok hivatkozásai rögzíthetők egy jegyzékben, és ellenőrizhetők, de maguknak a fájloknak létezniük kell a célkörnyezetben.

Konfiguráció

A Tartalomszinkronizálás engedélyezése itt: 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"
  }
}

A postTypes egy engedélyezőlista. Ha üres, a Tartalomszinkronizálás nem nyúl a bejegyzésekhez. A taxonomies a már regisztrált taxonómiák engedélyezőlistája; ezek kifejezéseit és bejegyzéskapcsolatait szinkronizálja. A Blockstudio nem regisztrál taxonómiadefiníciókat a Tartalomszinkronizálás fájljaiból. A postmeta- és termmeta-adatok engedélyezőlistáját a meta.include adja meg; a meta.exclude beállítás mindig elsőbbséget élvez.

Figyelmeztetés

Kezeld a meta.include értékét a véglegesítés határaként. A szinkronizált fájlokat a gitben kell tárolni, ezért ne vegyél fel olyan kulcsokat, amelyek titkokat, tokeneket, hitelesítő adatokat vagy személyazonosításra alkalmas adatokat tartalmaznak. A wp bs content status figyelmeztető sorokat jelez, ha egy engedélyezőlistán szereplő metakulcs érzékenynek tűnik.

A content.id a szinkronizált entitásokon _blockstudio_content_set értékként tárolódik. A törlési és tulajdonosi ellenőrzések erre az értékre korlátozódnak, így az egyik tartalomkészlet nem törölheti egy másik készlet tartalmát.

Az Oldalszinkronizálás által kezelt bejegyzések alapértelmezés szerint ki vannak zárva. Ha engedélyezed a includePageSyncManaged beállítást, a Tartalomszinkronizálás szinkronizálhatja a beállított metaadataikat, de a post_content továbbra is az Oldalszinkronizálás kezelésében marad.

Ezek a kivetítések a "bodyOwner": "page-sync" értéket tartalmazzák. A Pull a JSON írást csak metaadatként jelenti, és hozzáad egy skipped törzssort, így a bejegyzés nem úgy jelenik meg, mintha üres törzse lenne. Nem ír vagy töröl hozzá tartozó .html fájlt. A meglévő felülvizsgálati másolat megmarad, és a push figyelmen kívül hagyja. Ugyanezek a tulajdonosi üzenetek jelennek meg a próbaüzem kimenetében is.

Másik környezetben először futtassa a Page Syncet. A bodyOwner: "page-sync"-t tartalmazó projekciónak egy meglévő, Page Sync által kezelt bejegyzésre kell hivatkoznia; a push nem hoz létre üres helyettesítőt, és nem alkalmazza a törzs felülvizsgálati példányát. A régebbi verziókból származó, jelölő nélküli projekciók továbbra is támogatottak.

A szerzők alapértelmezés szerint kimaradnak, mert a felhasználók nincsenek szinkronizálva. A authors: "login" beállítással tárolhatod a szerző bejelentkezési nevét a bejegyzésfájlokban, majd feltöltéskor hozzárendelheted egy már létező felhasználóhoz. A hiányzó felhasználók előzetes ellenőrzési hibát okoznak; a Tartalomszinkronizálás nem hoz létre felhasználókat.

Parancsok

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

A pull adatbázis-tartalmat rögzít fájlokba. _blockstudio_content_uid értéket rendel azokhoz a hatókörbe eső bejegyzésekhez, amelyek még nem rendelkeznek ilyennel, és jelzi azokat az elavult fájlokat, amelyek adatbázisbeli forrása már nem létezik. A lekérés nem törli az elavult fájlokat.

A push a fájlok tartalmát alkalmazza az aktuális adatbázisra. Írás előtt ellenőrzi a tervet, és megakadályozza a feldolgozást, ha feloldatlan deklarált hivatkozások, slugütközések, zárolt entitások vagy hiányzó bejegyzéstípusok vannak.

A status összehasonlítja a fájlokat az adatbázissal, és minden entitásról jelzi, hogy unchanged, would-update, missing-db, conflict, locked vagy orphaned állapotú. Arra is figyelmeztet, ha egy engedélyezőlistán szereplő metakulcs titoknak tűnik, még mielőtt az értéket véglegesítenéd, valamint ha blokkjelölések törzsében numerikus azonosítók szerepelnek, mivel a Tartalomszinkronizálás nem írja át az azonosítókat a .html fájlokban.

A --dry-run használatával írás nélkül vizsgálhatsz meg egy lekérést vagy feltöltést. A push --prune --yes használatával eltávolíthatod azokat az adatbázis-entitásokat, amelyek a tartalomkészlet tulajdonában vannak, de már nem szerepelnek a fájlokban.

Hibák biztonságos kezelése

A push a teljes forrástervet feldolgozza és ellenőrzi, mielőtt írni vagy törölni kezdene. A hibás JSON, a fel nem oldott deklarált hivatkozások, az érvénytelen tulajdonosi viszonyok és más előzetes ellenőrzési hibák megakadályozzák a törlési fázist. A törlés továbbra is a beállított bejegyzéstípusokra, taxonómiákra és content.id korlátozódik.

A pull minden leképezett fájlt kiír, mielőtt az adott entitást szinkronizáltként rögzíti. A fájlrendszer írási hibája hibaállapotként jelenik meg, és nem frissíti az entitás tárolt szinkronizálási állapotát.

A mellékletek kezelése a content.media működését követi. A "manifest" beállítással a hivatkozott melléklet-UID-knek létezniük kell a célkörnyezetben. A "none" beállítással a deklarált melléklethivatkozások szándékosan kimaradnak a hordozható kimenetből, a környezetfüggő azonosítók megőrzése helyett.

Fájlok

A Content Sync fájlokat ír a beállított content.path alá:

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

A bejegyzéshez tartozó .json fájlok az identitást, a bejegyzés mezőit, a kifejezéstani kapcsolatokat, a deklarált metaadatokat és a metaadatok kódolását tárolják. A hozzájuk tartozó .html fájl nyers blokkjelölésként tárolja a post_content tartalmát, és üres tartalom esetén kimarad. A kifejezések .json fájljai az identitást, a taxonómiát, a slugot, a nevet, a leírást, a szülő-UID-t, a deklarált termmetaadatokat és a metaadatok kódolását tárolják.

A .html fájl nélküli másik eset a Page Sync által kezelt törzs, amelyet a fentiekben a bodyOwner azonosít. A szokásos bejegyzéseknél, amelyek törzse üressé válik, a pull eltávolítja a régi törzsfájlt, és egy külön deleted törzssorban tünteti fel.

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

A tárolt szinkronizálási állapot:

Metakulcs Rendeltetés
_blockstudio_content_uid Hordozható tartalomazonosság
_blockstudio_content_set A tartalomkészlet névtere innen: content.id
_blockstudio_content_source A témához viszonyított forrásfájl elérési útja
_blockstudio_content_fingerprint Az utolsó szinkronizált fájl-/adatbázis-ujjlenyomat
_blockstudio_content_locked Igaz értéke megakadályozza, hogy a push felülírja az entitást

Hivatkozások

A Content Sync soha nem feltételezi, hogy egy egész szám azonosító. Hivatkozásokat csak akkor ír át, ha azokat a meta.references konfigurálja.

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

Lekéréskor az ezeken az útvonalakon szereplő helyi azonosítók hordozható UID-kké alakulnak. Feltöltéskor az UID-k az aktuális adatbázisban tárolt helyi azonosítókra oldódnak fel.

A bejegyzések és kifejezések szülői, valamint a bejegyzés–kifejezés kapcsolatok a Content Sync által kezelt strukturális hivatkozások, amelyeket a rendszer automatikusan UID-ként tárol. A konfigurált taxonómiák akkor is bekerülnek a bejegyzésfájlokba, ha üresek; egy üres tömb feltöltéskor törli az adott taxonómia kapcsolatait.

A melléklethivatkozások ellenőrzése megtörténik, importálásuk nem. A media: "manifest" beállítással a hivatkozott mellékletek a content/media/manifest.json listáján jelennek meg; feltöltéskor a hivatkozott melléklet UID-jének helyben léteznie kell. A media: "none" beállítással a deklarált melléklethivatkozások kimaradnak a hordozható fájlokból. Mivel a kihagyott kulcs nem érvényesül feltöltéskor, a meglévő célbejegyzés megtartja az aktuális melléklet-metaadatait.

Hordozhatósági munkafolyamat

  1. Regisztrálja a célbejegyzés-típust minden környezetben.
  2. Állítsa be a content.postTypes, a meta.include és az összes deklarált hivatkozást.
  3. Futtassa a wp bs content pull parancsot a forráskörnyezetben.
  4. Véglegesítse a létrehozott fájlokat.
  5. Futtassa a wp bs content push parancsot a célkörnyezetben.
  6. Futtassa a wp bs content status parancsot az adatbázis és a fájlok egyezésének ellenőrzéséhez.

A push forrása a fájlokban található. Az adatbázis a pull paranccsal menthető vissza fájlokba.

Hatókör

A Content Sync az alábbiakat támogatja:

  • engedélyezőlistán szereplő bejegyzéstípusok bejegyzései
  • engedélyezőlistán szereplő bejegyzés-metaadatok
  • engedélyezőlistán szereplő, regisztrált taxonómiák kifejezései
  • engedélyezőlistán szereplő kifejezés-metaadatok
  • bejegyzés–kifejezés kapcsolatok
  • deklarált post, attachment és term hivatkozások
  • hordozható bejegyzés- és kifejezés-UID-k, valamint a tartalomkészlet tulajdonosi viszonyai
  • a Page Sync alapértelmezett kizárása
  • mellékletjegyzék és előzetes ellenőrzés
  • pull, push, status, --dry-run, --prune és a zárolt entitások kezelése

A taxonómia-definíciók rögzítése, a médiafájlok bináris másolása és a blokkjelölésekben szereplő azonosítók átírása nem támogatott.