Gå til indhold

GitHub

GitHub er den enkleste måde at hoste et register på. Push dine blokke til et repository, og brug GitHubs URL’er til råt indhold.

Opsætning

Opret et repository med denne struktur:

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

registry.json

Angiv baseUrl til den rå GitHub URL for din blocks/-mappe:

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 bruger raw.githubusercontent.com, så CLI henter det rå filindhold i stedet for GitHub HTML-siden.

Forbrugerkonfiguration

Brugere føjer dit register til deres blocks.json:

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

Derefter:

Shell
npx blockstudio add acme/hero

Fastlåsning til en udgivelse

Hvis du vil fastlåse en bestemt version, skal du bruge et tag eller en commit-SHA i stedet for main:

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

Det forhindrer, at ændringer, der bryder kompatibiliteten, påvirker eksisterende projekter, så længe registry.json ved det pågældende tag også bruger tagget i sin baseUrl. CLI henter blokfiler fra baseUrl, så en tagget registry.json, hvis baseUrl stadig peger på main, installerer filerne fra main. Det samme gælder for en commit-SHA: Den fastlåser bloklisten, mens filerne hentes fra den reference, som commit’ens baseUrl angiver.

GitHub Pages

Du kan også udgive et register via GitHub Pages, hvis du foretrækker en renere URL:

  1. Aktivér GitHub Pages for repositoryet
  2. Angiv baseUrl til din Pages-URL: https://acme.github.io/acme-blocks/blocks
  3. registry.json er tilgængeligt på https://acme.github.io/acme-blocks/registry.json

Private repositories

Til private repositories skal du bruge objektformatet for registre med et GitHub-adgangstoken:

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

Angiv tokenet i dit miljø:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Tokenet skal have omfanget repo (eller contents:read for finkornede tokens) for at få adgang til indhold i private repositories via raw.githubusercontent.com.