Přejít k obsahu

GitHub

GitHub je nejjednodušší způsob, jak hostovat registr. Nahrajte své bloky do repozitáře a použijte adresy URL se surovým obsahem od GitHub.

Nastavení

Vytvořte repozitář s touto strukturou:

Kód
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

Nastavte baseUrl na adresu URL se surovým obsahem GitHub URL pro adresář 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 používá raw.githubusercontent.com, aby CLI získal surový obsah souboru, nikoli stránku GitHub HTML.

Konfigurace uživatele

Uživatelé přidají váš registr do svého blocks.json:

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

Poté:

Shell
npx blockstudio add acme/hero

Připnutí ke konkrétnímu vydání

Chcete-li připnout konkrétní verzi, použijte místo main značku nebo SHA commitu:

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

Tím zabráníte tomu, aby změny narušující kompatibilitu ovlivnily existující projekty, pokud registry.json na dané značce používá značku také ve svém baseUrl. CLI stahuje soubory bloků z baseUrl, takže označený registry.json, jehož baseUrl stále odkazuje na main, nainstaluje soubory z main. Totéž platí pro SHA commitu: připne seznam bloků, zatímco soubory se načtou z refu, jehož název uvádí baseUrl daného commitu.

GitHub Pages

Registr můžete hostovat také prostřednictvím GitHub Pages, pokud dáváte přednost přehlednější URL:

  1. Povolte GitHub Pages pro repozitář
  2. Nastavte baseUrl na URL vašich Pages: https://acme.github.io/acme-blocks/blocks
  3. registry.json je dostupný na adrese https://acme.github.io/acme-blocks/registry.json

Soukromé repozitáře

U soukromých repozitářů použijte formát registru s objekty a osobní přístupový token GitHub:

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

Nastavte token v prostředí:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Token potřebuje oprávnění repo (nebo contents:read u tokenů s podrobným nastavením oprávnění), aby mohl přes raw.githubusercontent.com přistupovat k obsahu soukromého repozitáře.