Ugrás a tartalomhoz

GitHub

A GitHub a legegyszerűbb módja egy nyilvántartás üzemeltetésének. Küldd fel a blokkjaidat egy tárhelyre, és használd a GitHub nyers tartalmat megjelenítő URL-jeit.

Beállítás

Hozz létre egy ilyen felépítésű tárhelyet:

Kód
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

Állítsd be a baseUrl értékét a blocks/ könyvtárad nyers GitHub URL értékére:

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"]
    }
  ]
}

A baseUrl raw.githubusercontent.com-t használ, így a CLI a nyers fájltartalmat kapja meg, nem a GitHub HTML oldalát.

Fogyasztói konfiguráció

A felhasználók a blocks.json fájlban adják hozzá a nyilvántartásodat:

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

Ezután:

Shell
npx blockstudio add acme/hero

Rögzítés egy kiadásra

Egy adott verzió rögzítéséhez main helyett használj címkét vagy commit SHA-t:

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

Ez megakadályozza, hogy a kompatibilitást megtörő változások hatással legyenek a meglévő projektekre, feltéve, hogy az adott címkéhez tartozó registry.json is a címkét használja a baseUrl fájljában. A CLI a blokkfájlokat a baseUrl alapján tölti le, ezért egy címkézett registry.json, amelynek baseUrl értéke továbbra is main-ra mutat, a fájlokat a main-ből telepíti. Ugyanez vonatkozik a commit SHA-ra is: az a blokklistát rögzíti, a fájlok pedig arról a hivatkozásról érkeznek, amelyet az adott commit baseUrl-ja megad.

GitHub Pages

A nyilvántartást GitHub Pages útján is kiszolgálhatod, ha letisztultabb URL-t szeretnél:

  1. Engedélyezd a GitHub Pages szolgáltatást a tárhelyhez
  2. Állítsd be a baseUrl értékét a Pages URL-edre: https://acme.github.io/acme-blocks/blocks
  3. A registry.json itt lesz elérhető: https://acme.github.io/acme-blocks/registry.json

Privát tárhelyek

Privát tárhelyekhez használd az objektum-nyilvántartás formátumát egy GitHub személyes hozzáférési tokennel:

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

Állítsd be a tokent a környezetedben:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

A tokennek repo jogosultságra (vagy részletes jogosultságú tokenek esetén contents:read jogosultságra) van szüksége ahhoz, hogy a privát tárhelyek tartalmát raw.githubusercontent.com útján elérje.