Saltar al contenido

GitHub

GitHub es la forma más sencilla de alojar un registro. Envíe sus bloques a un repositorio y use las URL de contenido sin procesar de GitHub.

Configuración

Cree un repositorio con esta estructura:

Código
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

Establezca baseUrl en la GitHub URL sin procesar de su directorio 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"]
    }
  ]
}

El baseUrl usa raw.githubusercontent.com para que el CLI obtenga el contenido sin procesar del archivo, no la página GitHub HTML.

Configuración del consumidor

Los usuarios añaden el registro a su blocks.json:

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

A continuación:

Shell
npx blockstudio add acme/hero

Fijar una versión

Para fijar una versión específica, use una etiqueta o un SHA de confirmación en lugar de main:

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

Esto evita que los cambios incompatibles afecten a proyectos existentes, siempre que el registry.json de esa etiqueta también use la etiqueta en su baseUrl. El CLI descarga los archivos de bloque desde baseUrl, así que un registry.json etiquetado cuyo baseUrl siga apuntando a main instala los archivos de main. Lo mismo se aplica a un SHA de confirmación: fija la lista de bloques, mientras que los archivos proceden de la referencia que indique el baseUrl de esa confirmación.

GitHub Pages

También puede servir un registro mediante GitHub Pages si prefiere una URL más limpia:

  1. Habilite GitHub Pages para el repositorio
  2. Establezca baseUrl en su URL de Pages: https://acme.github.io/acme-blocks/blocks
  3. Se puede acceder al registry.json en https://acme.github.io/acme-blocks/registry.json

Repositorios privados

Para repositorios privados, use el formato de registro de objetos con un token personal de acceso GitHub:

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

Establezca el token en su entorno:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

El token necesita el alcance repo (o contents:read en el caso de tokens detallados) para acceder al contenido de repositorios privados mediante raw.githubusercontent.com.