Перейти к содержимому

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

Для доступа к содержимому приватного репозитория через raw.githubusercontent.com токену нужны разрешения repo (или contents:read для токенов с точечными разрешениями).