Gå til indhold

Indholdssynkronisering

Blockstudio er bygget op omkring et filbaseret workflow: blokke, felter, skabeloner, assets, mønstre og filbaserede sider kan alle ligge i dit projekt. Content Sync udvider modellen til udvalgt databaseindhold i WordPress for teams, der også vil have kuraterede indlæg, termer, relationer og erklærede metadata i git.

Det er et WP-CLI-workflow, ikke live replikering af databasen. Ved hentning projicerer Content Sync tilladte indlæg, postmeta, termer, termmeta og relationer mellem indlæg og termer til flytbare filer i dit tema. Ved overførsel anvender den filerne i et andet miljø ved hjælp af stabile UID’er og omskriver kun de referencer, du udtrykkeligt har erklæret.

Bemærk

Content Sync køres efter behov. Den kører ikke ved hver adminanmodning. Kommandoer returnerer en række med status sprunget over, indtil content.enabled er true.

Hvornår skal du bruge Content Sync

Brug Content Sync til indholdssæt, som det er vigtigt at versionsstyre, gennemgå og flytte mellem miljøer:

  • struktureret indhold såsom teammedlemmer, lokationer, casestudier, produkter, dokumentationsposter eller kampagnesider
  • taksonomier og relationer, der hører til disse indholdssæt
  • tilladte metadata, som er sikre at committe og har brug for stabile referencer
  • små til mellemstore indholdssæt, hvor det stadig er praktisk at gennemgå filer i git

Som tommelfingerregel fungerer Content Sync godt til snesevis eller hundredvis af rækker og kan håndtere nogle få tusinde, når dataene er strukturerede, ændres sjældent og er opdelt i fokuserede indlægstyper. Den er ikke beregnet til at spejle en hel produktionsdatabase, redaktionelt indhold med høj trafik, logs, ordrer, analyser, formularindsendelser, sessioner eller andre data med stor volumen eller hyppige ændringer. Hvis de genererede filer bliver støjende at gennemgå, det tager for lang tid at forstå overførslerne, eller de fleste rækker ændres uden for dit udrulningsworkflow, bør du i stedet bruge en databasesikkerhedskopi, migrering eller et import-/eksportværktøj.

Mediefiler kopieres ikke. Referencer til vedhæftninger kan registreres i et manifest og valideres, men selve filerne skal findes i målmiljøet.

Konfiguration

Aktivér Content Sync i 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 er en tilladelsesliste. Hvis den er tom, berører Content Sync ikke indlæg. taxonomies er en tilladelsesliste over allerede registrerede taksonomier, hvis termer og relationer til indlæg skal synkroniseres. Blockstudio registrerer ikke taksonomidefinitioner fra Content Sync-filer. Postmeta og termmeta tillades via meta.include; meta.exclude har altid forrang.

Advarsel

Behandl meta.include som en grænse for, hvad der committes. Synkroniserede filer skal ligge i git, så medtag ikke nøgler med hemmeligheder, tokens, legitimationsoplysninger eller personhenførbare oplysninger. wp bs content status rapporterer advarselsrækker, når en tilladt metanøgle ser følsom ud.

content.id gemmes på synkroniserede enheder som _blockstudio_content_set. Oprydning og ejerskabskontrol afgrænses efter denne værdi, så ét indholdssæt ikke kan slette indhold fra et andet.

Administrerede indlæg fra Page Sync er som standard udelukket. Hvis includePageSyncManaged er aktiveret, kan Content Sync synkronisere deres konfigurerede metadata, men Page Sync har stadig ansvaret for deres post_content.

Disse projektioner indeholder "bodyOwner": "page-sync". Pull rapporterer JSON-skrivningen som kun metadata og tilføjer en skipped-brødrække i stedet for at vise indlægget, som om det havde en tom brødtekst. Den skriver eller sletter ikke en tilhørende .html-fil. En eksisterende gennemgangskopi bevares og ignoreres af push. De samme ejerskabsmeddelelser medtages i dry-run-output.

Kør først Page Sync i det andet miljø. En projektion med bodyOwner: "page-sync" skal referere til et eksisterende indlæg, der administreres af Page Sync; push nægter at oprette en tom pladsholder eller anvende korrekturkopien af indlæggets indhold. Projektioner uden markøren fra ældre versioner understøttes fortsat.

Forfattere ignoreres som standard, fordi brugere ikke synkroniseres. Indstil authors: "login" for at gemme forfatterens login i indlægsfiler og knytte login’et til en eksisterende bruger ved overførsel. Manglende brugere udløser en fejl i forhåndskontrollen; Content Sync opretter ikke brugere.

Kommandoer

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 henter databaseindhold til filer. Den tildeler _blockstudio_content_uid til indlæg i området, der endnu ikke har et, og rapporterer forældede filer, hvis databasekilde ikke længere findes. Forældede filer slettes ikke ved hentning.

push anvender filer i den aktuelle database. Den validerer planen, før den skriver, og blokerer uløste erklærede referencer, konflikter mellem slugge, låste enheder og manglende indlægstyper.

status sammenligner filer med databasen og rapporterer hver enhed som unchanged, would-update, missing-db, conflict, locked eller orphaned. Den advarer også om tilladte metanøgler, der ligner hemmeligheder, før værdierne committes, og om numeriske ID’er i blokmarkup, fordi Content Sync ikke omskriver ID’er i .html-filer.

Brug --dry-run til at gennemgå en hentning eller overførsel uden at skrive. Brug push --prune --yes til at fjerne databaseenheder, der ejes af et indholdssæt, men ikke længere findes i filerne.

Beskyttelse mod fejl

push analyserer og validerer hele kildeplanen, før den skriver eller fjerner noget. Fejlformateret JSON, uafklarede erklærede referencer, ugyldigt ejerskab og andre fejl i forhåndskontrollen blokerer den destruktive fase. Fjernelse er fortsat begrænset til de konfigurerede indholdstyper, taksonomier og content.id.

pull skriver hver projiceret fil, før den registrerer entiteten som synkroniseret. En fejl ved skrivning til filsystemet returneres som en fejlrække og ændrer ikke den gemte synkroniseringstilstand for entiteten.

Håndtering af vedhæftninger følger content.media. Med "manifest" skal UID’er for refererede vedhæftninger findes i målmiljøet. Med "none" fjernes erklærede referencer til vedhæftninger bevidst fra det portable output i stedet for at bevare miljøspecifikke ID’er.

Filer

Content Sync skriver filer under den konfigurerede content.path:

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

Filer for indlæg .json gemmer identitet, indlægsfelter, termrelationer, erklærede metadata og metadatakodning. Den tilhørende .html-fil gemmer post_content som rå blokmarkup og udelades, når indholdet er tomt. Termfiler .json gemmer identitet, taksonomi, slug, navn, beskrivelse, overordnet UID, erklærede termmetadata og metadatakodning.

Det andet tilfælde uden en .html-fil er et indhold, der ejes af Page Sync, identificeret med bodyOwner ovenfor. For almindelige indlæg, hvis indhold bliver tomt, fjerner pull den gamle indholdsfil og angiver den i en separat deleted-række for indhold.

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

Den gemte synkroniseringstilstand er:

Metanøgle Formål
_blockstudio_content_uid Portabel indholdsidentitet
_blockstudio_content_set Navneområde for indholdssæt fra content.id
_blockstudio_content_source Temarelativ kildefilsti
_blockstudio_content_fingerprint Seneste synkroniserede fil-/databasefingeraftryk
_blockstudio_content_locked Sand værdi forhindrer push i at overskrive entiteten

Referencer

Content Sync gætter aldrig på, at et heltal er et ID. Referencer omskrives kun, når de er konfigureret i meta.references.

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

Ved pull bliver lokale ID’er på disse stier til portable UID’er. Ved push slås UID’erne op igen som lokale ID’er i den aktuelle database.

Indlægs overordnede elementer, termers overordnede elementer og relationer mellem indlæg og termer er strukturelle referencer, som ejes af Content Sync, og gemmes automatisk som UID’er. Konfigurerede taksonomier skrives til indlægsfiler, også når de er tomme; et tomt array rydder relationerne for den pågældende taksonomi ved push.

Referencer til vedhæftninger valideres, men importeres ikke. Med media: "manifest" vises refererede vedhæftninger i content/media/manifest.json; push kræver, at UID’et for den refererede vedhæftning findes lokalt. Med media: "none" udelades erklærede referencer til vedhæftninger fra portable filer. Da en udeladt nøgle ikke anvendes ved push, beholder et eksisterende målindlæg sine aktuelle metadata for vedhæftninger.

Portabilitetsworkflow

  1. Registrer målindlægstypen i hvert miljø.
  2. Konfigurer content.postTypes, meta.include og eventuelle erklærede referencer.
  3. Kør wp bs content pull i kildemiljøet.
  4. Commit de genererede filer.
  5. Kør wp bs content push i målmiljøet.
  6. Kør wp bs content status for at kontrollere, at databasen stemmer overens med filerne.

Filerne er den autoritative kilde for push. Databasen gemmes tilbage i filer med pull.

Omfang

Content Sync understøtter:

  • indlæg fra tilladte indlægstyper
  • tilladte indlægsmetadata
  • termer fra tilladte registrerede taksonomier
  • tilladte termmetadata
  • relationer mellem indlæg og termer
  • erklærede referencer til post, attachment og term
  • portable UID’er for indlæg og termer samt ejerskab af indholdssæt
  • udelukkelse af Page Sync som standard
  • manifest for vedhæftninger og validering før behandling
  • pull, push, status, --dry-run, --prune samt håndtering af låste entiteter

Registrering af taksonomidefinitioner, kopiering af mediefiler og omskrivning af ID’er i blokmarkup understøttes ikke.