Hoppa till innehåll

Innehållssynkronisering

Blockstudio bygger på ett filbaserat arbetsflöde: block, fält, mallar, resurser, mönster och filbaserade sidor kan alla finnas i ditt projekt. Innehållssynkronisering utökar den modellen till utvalt WordPress-databasinnehåll för team som också vill ha utvalda inlägg, termer, relationer och deklarerade metadata i git.

Det är ett WP-CLI arbetsflöde, inte en direkt replikering av databasen. Vid hämtning exporterar Innehållssynkronisering tillåtlistade inlägg, postmeta, termer, termmeta och relationer mellan inlägg och termer till portabla filer i ditt tema. Vid publicering tillämpar den filerna i en annan miljö med stabila UID:er och skriver bara om referenser som du uttryckligen deklarerar.

Obs!

Innehållssynkronisering körs vid behov. Den körs inte vid varje administratörsbegäran. Kommandon returnerar en rad med statusen skipped tills content.enabled är true.

När du ska använda Innehållssynkronisering

Använd Innehållssynkronisering för innehållsuppsättningar som är viktiga att versionshantera, granska och flytta mellan miljöer:

  • strukturerat innehåll som teammedlemmar, platser, fallstudier, produkter, dokumentationsposter eller kampanjsidor
  • taxonomier och relationer som hör till dessa innehållsuppsättningar
  • tillåtlistade metadata som är säkra att checka in och behöver stabila referenser
  • små till medelstora innehållsuppsättningar där det fortfarande är praktiskt att granska filer i git

Som tumregel passar Innehållssynkronisering bra för tiotals eller hundratals rader och kan fungera för ett par tusen när data är strukturerade, ändras sällan och är uppdelade i fokuserade inläggstyper. Den är inte avsedd att spegla en hel produktionsdatabas, redaktionellt innehåll med hög trafik, loggar, beställningar, analysdata, formulärinlämningar, sessioner eller andra datamängder med stor volym eller täta ändringar. Om de genererade filerna blir svåra att granska, om publiceringar tar för lång tid att bedöma eller om de flesta rader ändras utanför ditt distributionsflöde bör du i stället använda ett verktyg för säkerhetskopiering, migrering eller import/export av databaser.

Mediefiler kopieras inte. Bilagereferenser kan registreras i ett manifest och valideras, men själva filerna måste finnas i målmiljön.

Konfiguration

Aktivera Innehållssynkronisering 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 är en tillåtlista. Om den är tom påverkar Innehållssynkronisering inga inlägg. taxonomies är en tillåtlista med redan registrerade taxonomier vars termer och inläggsrelationer ska synkroniseras. Blockstudio registrerar inte taxonomidefinitioner från Innehållssynkroniseringsfiler. Postmeta och termmeta tillåtlistas via meta.include; meta.exclude vinner alltid.

Varning

Behandla meta.include som en gräns för vad som checkas in. Synkroniserade filer ska finnas i git, så ta inte med nycklar med hemligheter, token, inloggningsuppgifter eller personligt identifierbar information. wp bs content status rapporterar varningsrader när en tillåtlistad metanyckel verkar känslig.

content.id lagras på synkroniserade objekt som _blockstudio_content_set. Rensnings- och ägarskapskontroller begränsas till det värdet, så ett innehållsset kan inte ta bort ett annat sets innehåll.

Inlägg som hanteras av Page Sync utesluts som standard. Om includePageSyncManaged är aktiverat kan Innehållssynkronisering synkronisera deras konfigurerade metadata, men Page Sync äger fortfarande deras post_content.

Dessa projektioner innehåller "bodyOwner": "page-sync". Pull rapporterar skrivningen av JSON som endast metadata och lägger till en skipped-rad i innehållet, i stället för att visa inlägget som om det hade tomt innehåll. Den skriver inte eller tar bort en intilliggande .html-fil. En befintlig granskningskopia bevaras och ignoreras av push. Samma meddelanden om ägarskap ingår i utdata vid torrkörning.

Kör först Page Sync i en annan miljö. En projektion med bodyOwner: "page-sync" måste hänvisa till ett befintligt inlägg som hanteras av Page Sync; push vägrar att skapa en tom ersättning eller tillämpa granskningskopian av inläggets innehåll. Projektioner utan markören från äldre versioner stöds fortfarande.

Författare ignoreras som standard eftersom användare inte synkroniseras. Ange authors: "login" för att lagra författarens inloggningsnamn i inläggsfilerna och slå upp motsvarande befintliga användare vid publicering. Saknade användare ger ett fel i förkontrollen; Innehållssynkronisering skapar inte användare.

Kommandon

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 hämtar databasinnehåll till filer. Den tilldelar _blockstudio_content_uid till berörda inlägg som ännu saknar ett och rapporterar inaktuella filer vars databaskälla inte längre finns. Inaktuella filer tas inte bort vid hämtning.

push tillämpar filer i den aktuella databasen. Kommandot validerar planen innan det skriver och blockerar olösta deklarerade referenser, slugkonflikter, låsta objekt och saknade inläggstyper.

status jämför filer med databasen och rapporterar varje objekt som unchanged, would-update, missing-db, conflict, locked eller orphaned. Kommandot varnar också för tillåtlistade metanycklar som verkar innehålla hemligheter innan värdena checkas in, och för numeriska ID:n i blockmarkupens innehåll eftersom Innehållssynkronisering inte skriver om ID:n i .html-filer.

Använd --dry-run för att granska en hämtning eller publicering utan att skriva något. Använd push --prune --yes för att ta bort databasenheter som ägs av innehållssetet och inte längre finns i filerna.

Skydd mot fel

push tolkar och validerar hela källplanen innan det skriver eller rensar. Felaktig JSON, olösta deklarerade referenser, ogiltigt ägarskap och andra fel i förkontrollen blockerar den destruktiva fasen. Rensningen begränsas fortfarande till de konfigurerade inläggstyperna, taxonomierna och content.id.

pull skriver varje exporterad fil innan det registrerar objektet som synkroniserat. Ett fel vid skrivning till filsystemet returneras som en felrad och uppdaterar inte det lagrade synkroniseringstillståndet för objektet.

Hantering av bilagor följer content.media. Med "manifest" måste refererade bilage-UID:er finnas i målmiljön. Med "none" tas deklarerade bilagereferenser avsiktligt bort från det portabla resultatet i stället för att miljöspecifika ID:n bevaras.

Filer

Content Sync skriver filer under konfigurerad content.path:

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

Postfiler .json lagrar identitet, inläggsfält, termrelationer, deklarerad meta och meta-kodning. Den tillhörande .html-filen lagrar post_content som rå blockmarkering och utelämnas när innehållet är tomt. Termfiler .json lagrar identitet, taxonomi, slug, namn, beskrivning, överordnad UID, deklarerad termmeta och meta-kodning.

Det andra fallet utan någon .html-fil är ett innehåll som ägs av Page Sync, identifierat av bodyOwner ovan. För vanliga inlägg vars innehåll blir tomt tar pull bort den gamla innehållsfilen och anger den i en separat deleted-rad för innehåll.

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

Det lagrade synktillståndet är:

Metanyckel Syfte
_blockstudio_content_uid Portabel innehållsidentitet
_blockstudio_content_set Namnrymd för innehållsuppsättningen från content.id
_blockstudio_content_source Källfilsökväg relativ till temat
_blockstudio_content_fingerprint Senast synkroniserat fil-/databasfingeravtryck
_blockstudio_content_locked Ett sanningsenligt värde hindrar push från att skriva över entiteten

Referenser

Content Sync gissar aldrig att ett heltal är ett ID. Referenser skrivs om endast när de har konfigurerats i meta.references.

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

Vid hämtning blir lokala ID:n på dessa sökvägar portabla UID:er. Vid push löses UID:erna tillbaka till lokala ID:n i den aktuella databasen.

Inläggsföräldrar, termföräldrar och relationer mellan inlägg och termer är strukturella referenser som hanteras av Content Sync och lagras automatiskt som UID:er. Konfigurerade taxonomier skrivs till inläggsfiler även när de är tomma; en tom array rensar relationerna för den taxonomin vid push.

Bilagereferenser valideras, men importeras inte. Med media: "manifest" listas refererade bilagor i content/media/manifest.json; push kräver att den refererade bilagans UID finns lokalt. Med media: "none" utelämnas deklarerade bilagereferenser från portabla filer. Eftersom en utelämnad nyckel inte tillämpas vid push behåller ett befintligt målinlägg sin aktuella bilagemeta.

Portabilitetsarbetsflöde

  1. Registrera måltypen för inlägg i varje miljö.
  2. Konfigurera content.postTypes, meta.include och eventuella deklarerade referenser.
  3. Kör wp bs content pull i källmiljön.
  4. Checka in de genererade filerna.
  5. Kör wp bs content push i målmiljön.
  6. Kör wp bs content status för att verifiera att databasen stämmer överens med filerna.

Filerna är den enda sanningskällan för push. Databasen fångas tillbaka till filer med pull.

Omfattning

Content Sync har stöd för:

  • inlägg från tillåtna inläggstyper
  • tillåtna postmeta
  • termer från tillåtna registrerade taxonomier
  • tillåten termmeta
  • relationer mellan inlägg och termer
  • deklarerade referenser till post, attachment och term
  • portabla UID:er för inlägg och termer samt ägarskap för innehållsuppsättningar
  • uteslutning av Page Sync som standard
  • bilagemanifest och förhandsvalidering
  • pull, push, status, --dry-run, --prune och hantering av låsta entiteter

Det finns inte stöd för att fånga taxonomidefinitioner, kopiera mediefiler eller skriva om ID:n i blockmarkeringar.