Aller au contenu

GitHub

GitHub est le moyen le plus simple d’héberger un registre. Envoyez vos blocs dans un dépôt et utilisez les URL de contenu brut de GitHub.

Configuration

Créez un dépôt avec cette structure :

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

registry.json

Définissez baseUrl sur l’GitHub brut du URL de votre répertoire 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"]
    }
  ]
}

Le baseUrl utilise raw.githubusercontent.com afin que le CLI récupère le contenu brut du fichier, et non la page GitHub HTML.

Configuration côté utilisateur

Les utilisateurs ajoutent votre registre à leur blocks.json :

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

Ensuite :

Shell
npx blockstudio add acme/hero

Épingler sur une version

Pour épingler une version précise, utilisez une étiquette ou un SHA de commit au lieu de main :

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

Cela évite que des changements incompatibles affectent les projets existants, à condition que le registry.json de cette étiquette utilise aussi l’étiquette dans son baseUrl. Le CLI télécharge les fichiers de bloc depuis baseUrl ; ainsi, un registry.json étiqueté dont le baseUrl pointe toujours vers main installe les fichiers de main. Il en va de même pour un SHA de commit : il épingle la liste des blocs, tandis que les fichiers proviennent de la référence nommée par le baseUrl de ce commit.

GitHub Pages

Vous pouvez également servir un registre via GitHub Pages si vous préférez un URL plus propre :

  1. Activez GitHub Pages pour le dépôt
  2. Définissez baseUrl sur votre URL Pages : https://acme.github.io/acme-blocks/blocks
  3. Le registry.json est accessible à l’adresse https://acme.github.io/acme-blocks/registry.json

Dépôts privés

Pour les dépôts privés, utilisez le format de registre d’objets avec un jeton d’accès personnel GitHub :

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

Définissez le jeton dans votre environnement :

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Le jeton doit disposer de l’autorisation repo (ou contents:read pour les jetons à autorisations précises) pour accéder au contenu d’un dépôt privé via raw.githubusercontent.com.