Hoppa till innehåll

GitHub

GitHub är det enklaste sättet att värdhantera ett register. Skicka dina block till ett kodförråd och använd GitHubs URL:er till råinnehåll.

Konfiguration

Skapa ett kodförråd med den här strukturen:

Kod
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

Ange baseUrl till den råa GitHub-URL för din katalog blocks/:

JSON
{
  "name": "acme",
  "description": "Acme Corp block library.",
  "baseUrl": "https://raw.githubusercontent.com/acme/acme-blocks/main/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "category": "layout",
      "type": "blockstudio",
      "files": ["block.json", "index.php"]
    },
    {
      "name": "card",
      "title": "Card",
      "category": "components",
      "type": "blockstudio",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

baseUrl använder raw.githubusercontent.com så att CLI hämtar filens råinnehåll, inte sidan GitHub HTML.

Konsumentkonfiguration

Användare lägger till ditt register i sin blocks.json:

JSON
{
  "directory": "blockstudio",
  "registries": {
    "acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
  }
}

Sedan:

Shell
npx blockstudio add acme/hero

Låsa fast vid en utgåva

Om du vill låsa fast vid en viss version använder du en tagg eller en commit-SHA i stället för main:

JSON
{
  "registries": {
    "acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
  }
}

Detta förhindrar att ändringar som bryter kompatibiliteten påverkar befintliga projekt, så länge registry.json vid den taggen också använder taggen i sin baseUrl. CLI laddar ner blockfiler från baseUrl, så en taggad registry.json vars baseUrl fortfarande pekar på main installerar filerna från main. Detsamma gäller för en commit-SHA: den låser blocklistan, medan filerna hämtas från den referens som den commitens baseUrl anger.

GitHub Pages

Du kan också tillhandahålla ett register via GitHub Pages om du föredrar en renare URL:

  1. Aktivera GitHub Pages för kodförrådet
  2. Ange baseUrl till din Pages-URL: https://acme.github.io/acme-blocks/blocks
  3. registry.json är tillgänglig på https://acme.github.io/acme-blocks/registry.json

Privata kodförråd

För privata kodförråd använder du registerformatet för objekt med en personlig GitHub-åtkomsttoken:

JSON
{
  "registries": {
    "private": {
      "url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
      "headers": {
        "Authorization": "Bearer ${GITHUB_TOKEN}"
      }
    }
  }
}

Ange tokenen i din miljö:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Tokenen behöver omfattningen repo (eller contents:read för finkorniga token) för att komma åt innehåll i privata kodförråd via raw.githubusercontent.com.