Przejdź do treści

GitHub

GitHub to najprostszy sposób hostowania rejestru. Wypchnij bloki do repozytorium i użyj surowych adresów URL zawartości GitHub.

Konfiguracja

Utwórz repozytorium o następującej strukturze:

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

registry.json

Ustaw baseUrl na surowy GitHub URL katalogu 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 używa raw.githubusercontent.com, aby CLI otrzymał surową zawartość pliku, a nie stronę GitHub HTML.

Konfiguracja użytkownika

Użytkownicy dodają rejestr do swojego blocks.json:

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

Następnie:

Powłoka
npx blockstudio add acme/hero

Przypinanie do wydania

Aby przypiąć konkretną wersję, użyj tagu lub SHA commita zamiast main:

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

Zapobiega to wpływowi niezgodnych zmian na istniejące projekty, o ile registry.json pod tym tagiem również używa tagu w swoim baseUrl. CLI pobiera pliki bloków z baseUrl, więc otagowany registry.json, którego baseUrl nadal wskazuje na main, instaluje pliki z main. To samo dotyczy SHA commita: przypina on listę bloków, a pliki pochodzą z refa wskazanego przez baseUrl tego commita.

GitHub Pages

Jeśli wolisz czytelniejszy URL, możesz też udostępnić rejestr przez GitHub Pages:

  1. Włącz GitHub Pages dla repozytorium
  2. Ustaw baseUrl na URL Pages: https://acme.github.io/acme-blocks/blocks
  3. registry.json jest dostępny pod adresem https://acme.github.io/acme-blocks/registry.json

Repozytoria prywatne

W przypadku prywatnych repozytoriów użyj formatu rejestru obiektów z osobistym tokenem dostępu GitHub:

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

Ustaw token w swoim środowisku:

Powłoka
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Token musi mieć zakres repo (lub contents:read w przypadku tokenów o precyzyjnie określonych uprawnieniach), aby uzyskać dostęp do zawartości prywatnego repozytorium przez raw.githubusercontent.com.