Siirry sisältöön

GitHub

GitHub on yksinkertaisin tapa isännöidä rekisteriä. Vie lohkosi repositorioon ja käytä GitHubn raakasisältö-URL-osoitteita.

Määritys

Luo repositorio, jonka rakenne on seuraava:

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

registry.json

Aseta baseUrl osoittamaan blocks/-hakemistosi raakasisällön GitHub-URL-osoitteeseen:

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 käyttää raw.githubusercontent.com-osoitetta, jotta CLI saa tiedoston raakasisällön eikä GitHubn HTML-sivua.

Käyttäjän määritykset

Käyttäjät lisäävät rekisterisi omaan blocks.json-tiedostoonsa:

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

Sen jälkeen:

Shell
npx blockstudio add acme/hero

Kiinnittäminen julkaisuversioon

Kiinnitä tiettyyn versioon käyttämällä tunnistetta tai commit-SHA:ta mainn sijaan:

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

Tämä estää rikkovia muutoksia vaikuttamasta olemassa oleviin projekteihin, kunhan kyseisen tunnisteen registry.json käyttää tunnistetta myös omassa baseUrl-määrityksessään. CLI lataa lohkotiedostot osoitteesta baseUrl, joten tunnisteella varustettu registry.json, jonka baseUrl osoittaa edelleen kohtaan main, asentaa tiedostot osoitteesta main. Sama pätee commit-SHA:han: se kiinnittää lohkoluettelon, kun taas tiedostot haetaan siitä viitteestä, johon kyseisen commitin baseUrl osoittaa.

GitHub Pages

Voit myös tarjota rekisteriä GitHub Pagesn kautta, jos haluat siistimmän URLn:

  1. Ota repositorion GitHub Pages käyttöön
  2. Aseta baseUrl Pages-URL-osoitteeksesi: https://acme.github.io/acme-blocks/blocks
  3. registry.json on käytettävissä osoitteessa https://acme.github.io/acme-blocks/registry.json

Yksityiset repositoriot

Käytä yksityisissä repoissa objektirekisterin muotoa ja GitHub-käyttöoikeustunnusta:

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

Aseta tunnus ympäristömuuttujaan:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Tunnus tarvitsee repo-käyttöoikeuden (tai contents:read hienojakoisille tunnuksille), jotta yksityisen repositorion sisältöä voi käyttää raw.githubusercontent.comn kautta.