Pāriet uz saturu

Satura sinhronizācija

Blockstudio pamatā ir failos balstīta darbplūsma: bloki, lauki, veidnes, resursi, raksti un lapas failos var atrasties jūsu projektā. Satura sinhronizācija paplašina šo modeli, iekļaujot atlasītu WordPress datubāzes saturu komandām, kas vēlas git glabāt arī atlasītas ziņas, terminus, saistības un deklarētus metadatus.

Šī ir WP-CLI darbplūsma, nevis datubāzes replikācija reāllaikā. Iegūšanas laikā Satura sinhronizācija atļauto sarakstā iekļautās ziņas, ziņu metadatus, terminus, terminu metadatus un ziņu un terminu saistības pārvērš pārnesamos failos jūsu tēmā. Nosūtīšanas laikā šie faili tiek lietoti citā vidē, izmantojot stabilus UID un pārrakstot tikai tās atsauces, kuras skaidri deklarējat.

Piezīme

Satura sinhronizācija darbojas pēc pieprasījuma. Tā netiek izpildīta katrā administratora pieprasījumā. Kamēr content.enabled nav true, komandas atgriež izlaistu rindu.

Kad izmantot satura sinhronizāciju

Izmantojiet satura sinhronizāciju satura kopām, kuras ir svarīgi versēt, pārskatīt un pārvietot starp vidēm:

  • strukturētam saturam, piemēram, komandas dalībniekiem, atrašanās vietām, gadījumu izpētēm, produktiem, dokumentācijas ierakstiem vai kampaņu lapām
  • taksonomijām un saistībām, kas pieder šīm satura kopām
  • atļautajā sarakstā iekļautiem metadatiem, kurus ir droši nodot versiju kontrolē un kuriem vajadzīgas stabilas atsauces
  • mazām vai vidēja lieluma satura kopām, kurās failu pārskatīšana git vidē joprojām ir praktiska

Parasti Satura sinhronizācija ir piemērota desmitiem vai simtiem ierakstu; ja dati ir strukturēti, reti mainās un sadalīti mērķtiecīgos ziņu veidos, var strādāt arī ar dažiem tūkstošiem. Tā nav paredzēta visas produkcijas datubāzes, bieži apmeklēta redakcionālā satura, žurnālu, pasūtījumu, analītikas datu, veidlapu iesniegumu, sesiju vai citu apjomīgu vai bieži mainīgu datu kopu atspoguļošanai. Ja ģenerētos failus kļūst grūti pārskatīt, nosūtīšanas darbību izvērtēšana aizņem pārāk ilgu laiku vai lielākā daļa ierakstu mainās ārpus izvietošanas darbplūsmas, izmantojiet datubāzes dublējumu, migrāciju vai importēšanas/eksportēšanas rīku.

Multivides binārie faili netiek kopēti. Pielikumu atsauces var ierakstīt manifestā un validēt, bet pašiem failiem ir jābūt pieejamiem mērķa vidē.

Konfigurācija

Iespējojiet satura sinhronizāciju sadaļā 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 ir atļauto saraksts. Ja tas ir tukšs, satura sinhronizācija neaiztiek ziņas. taxonomies ir jau reģistrētu taksonomiju atļauto saraksts; to termini un ziņu saistības ir jāsinhronizē. Blockstudio nereģistrē taksonomiju definīcijas no Satura sinhronizācijas failiem. Ziņu un terminu metadati tiek iekļauti atļautajā sarakstā ar meta.include; meta.exclude vienmēr ir noteicošais.

Brīdinājums

Uztveriet meta.include kā robežu tam, ko nododat versiju kontrolē. Sinhronizētie faili ir paredzēti glabāšanai git vidē, tāpēc neiekļaujiet atslēgas, kurās glabājas noslēpumi, tokeni, akreditācijas dati vai personas dati. wp bs content status ziņo brīdinājuma rindas, ja atļautā saraksta metadatu atslēga izskatās sensitīva.

content.id sinhronizētajās vienībās tiek saglabāts kā _blockstudio_content_set. Atzarošanas un īpašumtiesību pārbaudes ir ierobežotas ar šo vērtību, tāpēc viena satura kopa nevar izdzēst citas kopas saturu.

Lapas sinhronizācijas pārvaldītās ziņas pēc noklusējuma tiek izslēgtas. Ja ir iespējots includePageSyncManaged, Satura sinhronizācija var sinhronizēt tām konfigurētos metadatus, bet Lapas sinhronizācija joprojām pārvalda to post_content.

Šajās projekcijās ir "bodyOwner": "page-sync". Pull ziņojumos JSON rakstīšana ir norādīta kā tikai metadatu rakstīšana un tiek pievienota skipped pamatteksta rinda, nevis ieraksts attēlots tā, it kā tam būtu tukšs pamatteksts. Netiek ierakstīts vai dzēsts blakus esošs .html fails. Esoša pārskatīšanas kopija tiek saglabāta, un push to ignorē. Tādi paši īpašumtiesību ziņojumi tiek iekļauti sausās palaišanas izvadē.

Citā vidē vispirms palaidiet Page Sync. Projekcijai ar bodyOwner: "page-sync" ir jāattiecas uz esošu Page Sync pārvaldītu ierakstu; push atsakās izveidot tukšu aizstājēju vai lietot šī satura pārskatīto kopiju. Projekcijas bez šī marķiera no vecākām versijām joprojām tiek atbalstītas.

Pēc noklusējuma autori tiek ignorēti, jo lietotāji netiek sinhronizēti. Iestatiet authors: "login", lai ziņu failos saglabātu autora pieteikšanās vārdu un nosūtīšanas laikā piesaistītu to esošam lietotājam. Ja lietotājs nav atrodams, priekšpārbaude neizdodas; Satura sinhronizācija lietotājus neveido.

Komandas

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

pull ieraksta datubāzes saturu failos. Tas piešķir _blockstudio_content_uid attiecīgajām ziņām, kurām tāda vēl nav, un uzrāda novecojušus failus, kuru datubāzes avots vairs nepastāv. Novecojuši faili iegūšanas laikā netiek dzēsti.

push lieto failus pašreizējā datubāzē. Pirms rakstīšanas tas validē plānu un bloķē neatrisinātas deklarētās atsauces, slug konfliktus, bloķētas vienības un trūkstošus ziņu tipus.

status salīdzina failus ar datubāzi un katrai vienībai norāda vienu no stāvokļiem: unchanged, would-update, missing-db, conflict, locked vai orphaned. Pirms šo vērtību nodošanas versiju kontrolē tas arī brīdina par atļauto sarakstā iekļautām metadatu atslēgām, kas izskatās pēc noslēpumiem, kā arī par skaitliskiem ID bloku marķējuma pamattekstā, jo Satura sinhronizācija nepārraksta ID .html failos.

Izmantojiet --dry-run, lai pārbaudītu iegūšanu vai nosūtīšanu bez rakstīšanas. Izmantojiet push --prune --yes, lai no datubāzes dzēstu satura kopas pārvaldītās vienības, kas failos vairs nepastāv.

Droša kļūmju apstrāde

push parsē un validē visu avota plānu, pirms raksta vai veic atzarošanu. Nepareizi veidots JSON, neatrisinātas deklarētās atsauces, nederīgas īpašumtiesības un citas priekšpārbaudes kļūdas bloķē destruktīvo fāzi. Atzarošana ir ierobežota ar konfigurētajiem ziņu tipiem, taksonomijām un content.id.

pull vispirms ieraksta katru attēloto failu un tikai pēc tam atzīmē attiecīgo vienību kā sinhronizētu. Ja failu sistēmā rodas rakstīšanas kļūda, tiek atgriezta kļūdas rinda un šīs vienības saglabātais sinhronizācijas stāvoklis netiek atjaunināts.

Pielikumu apstrāde notiek saskaņā ar content.media. Izmantojot "manifest", norādītajiem pielikumu UID ir jābūt pieejamiem mērķa vidē. Izmantojot "none", deklarētās atsauces uz pielikumiem tiek apzināti izņemtas no pārnesamās izvades, nevis saglabāti videi specifiski ID.

Faili

Content Sync raksta failus konfigurētajā content.path:

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

Ierakstu .json faili glabā identitāti, ieraksta laukus, terminu attiecības, deklarētos metadatus un metadatu kodējumu. Blakus esošajā failā .html neapstrādāts bloku marķējums tiek glabāts kā post_content, un šis fails netiek iekļauts, ja saturs ir tukšs. Terminu .json faili glabā identitāti, taksonomiju, slug, nosaukumu, aprakstu, vecāktermiņa UID, deklarētos termmeta datus un metadatu kodējumu.

Otrs gadījums, kad nav .html faila, ir Page Sync pārvaldīts saturs, kas identificēts ar bodyOwner iepriekš. Parastiem ierakstiem, kuru saturs kļūst tukšs, pull noņem veco satura failu un norāda to atsevišķā deleted satura rindā.

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

Saglabātais sinhronizācijas stāvoklis ir šāds:

Metadatu atslēga Nolūks
_blockstudio_content_uid Pārnesama satura identitāte
_blockstudio_content_set Satura kopas nosaukumvieta no content.id
_blockstudio_content_source Ar tēmu saistīts avota faila ceļš
_blockstudio_content_fingerprint Pēdējais sinhronizētā faila/datubāzes kontrolsummas nospiedums
_blockstudio_content_locked Patiesa vērtība neļauj push darbībai pārrakstīt entītiju

Atsauces

Content Sync nekad nepieņem, ka vesels skaitlis ir ID. Atsauces tiek pārrakstītas tikai tad, ja tās ir konfigurētas meta.references.

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

Veicot pull, lokālie ID šajos ceļos kļūst par pārnesamiem UID. Veicot push, UID tiek pārvērsti par lokāliem ID pašreizējā datubāzē.

Ierakstu vecākieraksti, terminu vecāktermini un ierakstu un terminu attiecības ir Content Sync pārvaldītas strukturālas atsauces, un tās automātiski tiek saglabātas kā UID. Konfigurētās taksonomijas tiek ierakstītas ierakstu failos pat tad, ja tās ir tukšas; tukšs masīvs, veicot push, dzēš šīs taksonomijas attiecības.

Pielikumu atsauces tiek pārbaudītas, nevis importētas. Izmantojot media: "manifest", norādītie pielikumi tiek uzskaitīti failā content/media/manifest.json; veicot push, norādītajam pielikuma UID ir jābūt pieejamam lokāli. Izmantojot media: "none", deklarētās atsauces uz pielikumiem tiek izlaistas no pārnesamajiem failiem. Tā kā izlaista atslēga netiek lietota, veicot push, mērķa ierakstā tiek saglabāti pašreizējie pielikumu metadati.

Pārnesamības darbplūsma

  1. Reģistrējiet mērķa ieraksta tipu katrā vidē.
  2. Konfigurējiet content.postTypes, meta.include un visas deklarētās atsauces.
  3. Avota vidē palaidiet wp bs content pull.
  4. Nododiet ģenerētos failus versiju kontrolei.
  5. Mērķa vidē palaidiet wp bs content push.
  6. Palaidiet wp bs content status, lai pārbaudītu, vai datubāze atbilst failiem.

Faili ir push patiesais avots. Datubāze tiek ierakstīta atpakaļ failos, izmantojot pull.

Tvērums

Content Sync atbalsta:

  • ierakstus no atļauto ierakstu tipu saraksta
  • atļautos ierakstu metadatus
  • terminus no atļauto reģistrēto taksonomiju saraksta
  • atļautos termmeta datus
  • ierakstu un terminu attiecības
  • deklarētās atsauces post, attachment un term
  • pārnesamus ierakstu un terminu UID, kā arī satura kopas piederību
  • Page Sync izslēgšanu pēc noklusējuma
  • pielikumu manifestu un sākotnējo validāciju
  • pull, push, status, --dry-run, --prune un bloķētu entītiju apstrādi

Taksonomiju definīciju uztveršana, multivides bināro failu kopēšana un ID pārrakstīšana bloku marķējumā netiek atbalstīta.