Vai al contenuto

GitHub

GitHub è il modo più semplice per ospitare un registro. Caricate i vostri blocchi in un repository e usate gli URL dei contenuti raw di GitHub.

Configurazione

Create un repository con questa struttura:

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

registry.json

Impostate baseUrl sull’GitHub raw URL della directory 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"]
    }
  ]
}

Il baseUrl usa raw.githubusercontent.com, così il CLI recupera il contenuto raw del file, anziché la pagina GitHub HTML.

Configurazione del consumer

Gli utenti aggiungono il registro al proprio blocks.json:

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

Poi:

Shell
npx blockstudio add acme/hero

Blocco a una release

Per bloccare una versione specifica, usate un tag o lo SHA di un commit anziché main:

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

In questo modo le modifiche incompatibili non influiscono sui progetti esistenti, purché anche il registry.json associato a quel tag usi il tag nel proprio baseUrl. Il CLI scarica i file dei blocchi da baseUrl, quindi un registry.json etichettato il cui baseUrl punta ancora a main installa i file da main. Lo stesso vale per uno SHA di commit: blocca l’elenco dei blocchi, mentre i file provengono dal riferimento indicato dal baseUrl di quel commit.

GitHub Pages

Se preferite un URL più pulito, potete anche distribuire un registro tramite GitHub Pages:

  1. Abilitate GitHub Pages per il repository
  2. Impostate baseUrl sul URL di Pages: https://acme.github.io/acme-blocks/blocks
  3. Il registry.json è accessibile all’indirizzo https://acme.github.io/acme-blocks/registry.json

Repository privati

Per i repository privati, usate il formato di registro object con un token di accesso personale GitHub:

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

Impostate il token nell’ambiente:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Per accedere ai contenuti dei repository privati tramite raw.githubusercontent.com, il token deve avere l’ambito repo (oppure contents:read per i token granulari).