Перейти до вмісту

GitHub

GitHub — найпростіший спосіб розмістити реєстр. Надішліть блоки до репозиторію та використовуйте URL-адреси сирого вмісту GitHub.

Налаштування

Створіть репозиторій із такою структурою:

Код
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

Укажіть baseUrl як адресу сирого GitHub URL для свого каталогу 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 використовує raw.githubusercontent.com, щоб CLI отримував вміст сирого файлу, а не сторінку GitHub HTML.

Конфігурація споживача

Користувачі додають ваш реєстр до свого blocks.json:

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

Далі:

Командна оболонка
npx blockstudio add acme/hero

Фіксація версії

Щоб зафіксувати певну версію, використовуйте тег або SHA коміту замість main:

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

Це не дасть несумісним змінам вплинути на наявні проєкти, якщо registry.json у цьому тегу також використовує тег у своєму baseUrl. CLI завантажує файли блоків із baseUrl, тож для позначеного тегом registry.json, чий baseUrl досі вказує на main, буде встановлено файли з main. Те саме стосується SHA коміту: він фіксує список блоків, а файли беруться з посилання, названого у baseUrl цього коміту.

GitHub Pages

Також можна розмістити реєстр через GitHub Pages, якщо вам потрібен охайніший URL:

  1. Увімкніть GitHub Pages для репозиторію
  2. Укажіть baseUrl як URL Pages: https://acme.github.io/acme-blocks/blocks
  3. Реєстр буде доступний за адресою https://acme.github.io/acme-blocks/registry.json registry.json

Приватні репозиторії

Для приватних репозиторіїв використовуйте формат реєстру об’єктів із персональним токеном доступу GitHub:

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

Укажіть токен у змінній середовища:

Командна оболонка
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Токену потрібна область дії repo (або contents:read для токенів із точковими дозволами), щоб отримувати вміст приватного репозиторію через raw.githubusercontent.com.