Preskočiť na obsah

GitHub

GitHub je najjednoduchší spôsob, ako hostovať register. Nahrajte svoje bloky do úložiska a použite adresy URL s nespracovaným obsahom od GitHub.

Nastavenie

Vytvorte úložisko s touto štruktúrou:

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 nespracovaného GitHub URL pre adresár 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žíva raw.githubusercontent.com, aby CLI získal nespracovaný obsah súboru, a nie stránku GitHub HTML.

Konfigurácia používateľa

Používatelia pridajú váš register do svojho blocks.json:

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

Potom:

Shell
npx blockstudio add acme/hero

Pripnutie k vydaniu

Ak chcete pripnúť konkrétnu verziu, namiesto main použite značku alebo SHA commitu:

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

Tým zabránite tomu, aby zmeny spôsobujúce nekompatibilitu ovplyvnili existujúce projekty, ak registry.json pri danej značke používa túto značku aj vo svojom baseUrl. CLI sťahuje súbory blokov z baseUrl, takže označený registry.json, ktorého baseUrl stále smeruje na main, nainštaluje súbory z main. To isté platí pre SHA commitu: pripne zoznam blokov, pričom súbory sa načítajú z referencie, ktorú uvádza baseUrl daného commitu.

GitHub Pages

Register môžete sprístupniť aj cez GitHub Pages, ak uprednostňujete čistejšiu URL:

  1. Povoľte GitHub Pages pre úložisko
  2. Nastavte baseUrl na svoju adresu URL pre Pages: https://acme.github.io/acme-blocks/blocks
  3. registry.json bude dostupný na adrese https://acme.github.io/acme-blocks/registry.json

Súkromné úložiská

Pri súkromných úložiskách použite formát registra objektov s osobným prístupovým tokenom GitHub:

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

Nastavte token v prostredí:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Token potrebuje rozsah repo (alebo contents:read pri tokenoch s podrobným rozsahom oprávnení), aby získal prístup k obsahu súkromného úložiska cez raw.githubusercontent.com.